This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_syswm.h
244 lines (209 loc) · 5.63 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2010 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
14
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
*/
23
/**
24
25
26
* \file SDL_syswm.h
*
* Include file for SDL custom system window manager hooks.
27
*/
28
29
30
31
#ifndef _SDL_syswm_h
#define _SDL_syswm_h
32
#include "SDL_stdinc.h"
33
#include "SDL_error.h"
34
#include "SDL_video.h"
35
36
37
38
39
#include "SDL_version.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
40
/* *INDENT-OFF* */
41
extern "C" {
42
/* *INDENT-ON* */
43
44
#endif
45
46
47
48
49
50
51
52
/**
* \file SDL_syswm.h
*
* Your application has access to a special type of event ::SDL_SYSWMEVENT,
* which contains window-manager specific information and arrives whenever
* an unhandled window event occurs. This event is ignored by default, but
* you can enable it with SDL_EventState().
*/
53
54
55
56
#ifdef SDL_PROTOTYPES_ONLY
struct SDL_SysWMinfo;
#else
57
/* This is the structure for custom window manager events */
58
#if defined(SDL_VIDEO_DRIVER_X11)
59
#if defined(__APPLE__) && defined(__MACH__)
60
/* conflicts with Quickdraw.h */
61
62
63
#define Cursor X11Cursor
#endif
64
65
66
#include <X11/Xlib.h>
#include <X11/Xatom.h>
67
#if defined(__APPLE__) && defined(__MACH__)
68
/* matches the re-define above */
69
70
71
#undef Cursor
#endif
72
73
74
/**
* These are the various supported subsystems under UNIX.
*/
75
76
77
typedef enum
{
SDL_SYSWM_X11
78
79
} SDL_SYSWM_TYPE;
80
81
82
/**
* The UNIX custom event structure.
*/
83
84
85
86
87
88
89
90
struct SDL_SysWMmsg
{
SDL_version version;
SDL_SYSWM_TYPE subsystem;
union
{
XEvent xevent;
} event;
91
92
};
93
94
95
96
97
/**
* The UNIX custom window manager information structure.
*
* When this structure is returned, it holds information about which
* low level system it is using, and will be one of SDL_SYSWM_TYPE.
98
*/
99
100
101
102
103
104
105
106
struct SDL_SysWMinfo
{
SDL_version version;
SDL_SYSWM_TYPE subsystem;
union
{
struct
{
107
108
Display *display; /**< The X11 display */
Window window; /**< The X11 display window */
109
110
111
} x11;
} info;
};
112
113
#elif defined(SDL_VIDEO_DRIVER_WIN32)
114
115
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
116
117
118
119
/**
* The windows custom event structure.
*/
120
121
122
struct SDL_SysWMmsg
{
SDL_version version;
123
124
125
126
HWND hwnd; /**< The window for the message */
UINT msg; /**< The type of message */
WPARAM wParam; /**< WORD message parameter */
LPARAM lParam; /**< LONG message parameter */
127
128
};
129
130
131
/**
* The windows custom window manager information structure.
*/
132
133
134
struct SDL_SysWMinfo
{
SDL_version version;
135
HWND window; /**< The Win32 display window */
136
};
137
138
#elif defined(SDL_VIDEO_DRIVER_RISCOS)
139
140
141
142
/**
* RISC OS custom event structure.
*/
143
144
145
struct SDL_SysWMmsg
{
SDL_version version;
146
int eventCode; /**< The window for the message */
147
int pollBlock[64];
148
149
};
150
151
152
/**
* The RISC OS custom window manager information structure.
*/
153
154
155
struct SDL_SysWMinfo
{
SDL_version version;
156
157
158
int wimpVersion; /**< Wimp version running under */
int taskHandle; /**< The RISC OS task handle */
int window; /**< The RISC OS display window */
159
};
160
161
#elif defined(SDL_VIDEO_DRIVER_PHOTON) || defined(SDL_VIDEO_DRIVER_QNXGF)
162
#include <sys/neutrino.h>
163
164
165
#if defined(SDL_VIDEO_OPENGL_ES)
#include <gf/gf.h>
#endif /* SDL_VIDEO_OPENGL_ES */
166
167
#include <Ph.h>
168
169
170
/**
* The QNX custom event structure.
*/
171
172
173
174
struct SDL_SysWMmsg
{
SDL_version version;
int data;
175
176
};
177
178
179
/**
* The QNX Photon custom window manager information structure.
*/
180
181
182
183
184
struct SDL_SysWMinfo
{
SDL_version version;
int data;
};
185
186
187
#else
188
189
190
/**
* The generic custom event structure.
*/
191
192
193
194
struct SDL_SysWMmsg
{
SDL_version version;
int data;
195
196
};
197
198
199
/**
* The generic custom window manager information structure.
*/
200
201
202
203
204
struct SDL_SysWMinfo
{
SDL_version version;
int data;
};
205
206
#endif /* video driver type */
207
208
209
#endif /* SDL_PROTOTYPES_ONLY */
210
211
typedef struct SDL_SysWMinfo SDL_SysWMinfo;
212
/* Function prototypes */
213
/**
214
215
* \brief This function allows access to driver-dependent window information.
*
216
* \param window The window about which information is being requested
217
218
219
220
221
222
223
224
* \param info This structure must be initialized with the SDL version, and is
* then filled in with information about the given window.
*
* \return SDL_TRUE if the function is implemented and the version member of
* the \c info struct is valid, SDL_FALSE otherwise.
*
* You typically use this function like this:
* \code
225
* SDL_SysWMinfo info;
226
227
228
* SDL_VERSION(&info.version);
* if ( SDL_GetWindowWMInfo(&info) ) { ... }
* \endcode
229
*/
230
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
231
SDL_SysWMinfo * info);
232
233
234
235
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
236
/* *INDENT-OFF* */
237
}
238
/* *INDENT-ON* */
239
240
241
242
#endif
#include "close_code.h"
#endif /* _SDL_syswm_h */
243
244
/* vi: set ts=4 sw=4 expandtab: */