This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_syswm.h
270 lines (234 loc) · 6.37 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) || defined(SDL_VIDEO_DRIVER_DIRECTFB)
59
#if defined(SDL_VIDEO_DRIVER_X11)
60
#if defined(__APPLE__) && defined(__MACH__)
61
/* conflicts with Quickdraw.h */
62
63
64
#define Cursor X11Cursor
#endif
65
66
67
#include <X11/Xlib.h>
#include <X11/Xatom.h>
68
#if defined(__APPLE__) && defined(__MACH__)
69
/* matches the re-define above */
70
71
72
#undef Cursor
#endif
73
74
75
76
77
#endif /* defined(SDL_VIDEO_DRIVER_X11) */
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
#include <directfb/directfb.h>
#endif
78
79
80
/**
* These are the various supported subsystems under UNIX.
*/
81
82
typedef enum
{
83
84
85
86
87
88
#if defined(SDL_VIDEO_DRIVER_X11)
SDL_SYSWM_X11,
#endif
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
SDL_SYSWM_DIRECTFB,
#endif
89
90
} SDL_SYSWM_TYPE;
91
92
93
/**
* The UNIX custom event structure.
*/
94
95
96
97
98
99
struct SDL_SysWMmsg
{
SDL_version version;
SDL_SYSWM_TYPE subsystem;
union
{
100
#if defined(SDL_VIDEO_DRIVER_X11)
101
XEvent xevent;
102
103
104
105
#endif
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
DFBEvent dfb_event;
#endif
106
} event;
107
108
};
109
110
111
112
113
/**
* 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.
114
*/
115
116
117
118
119
120
struct SDL_SysWMinfo
{
SDL_version version;
SDL_SYSWM_TYPE subsystem;
union
{
121
#if defined(SDL_VIDEO_DRIVER_X11)
122
123
struct
{
124
125
Display *display; /**< The X11 display */
Window window; /**< The X11 display window */
126
} x11;
127
128
129
130
131
132
133
134
135
#endif
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
struct
{
IDirectFB *dfb; /**< The directfb main interface */
IDirectFBWindow *window; /**< The directfb window handle */
IDirectFBSurface *surface; /**< The directfb client surface */
} directfb;
#endif
136
137
} info;
};
138
139
#elif defined(SDL_VIDEO_DRIVER_WIN32)
140
141
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
142
143
144
145
/**
* The windows custom event structure.
*/
146
147
148
struct SDL_SysWMmsg
{
SDL_version version;
149
150
151
152
HWND hwnd; /**< The window for the message */
UINT msg; /**< The type of message */
WPARAM wParam; /**< WORD message parameter */
LPARAM lParam; /**< LONG message parameter */
153
154
};
155
156
157
/**
* The windows custom window manager information structure.
*/
158
159
160
struct SDL_SysWMinfo
{
SDL_version version;
161
HWND window; /**< The Win32 display window */
162
};
163
164
#elif defined(SDL_VIDEO_DRIVER_RISCOS)
165
166
167
168
/**
* RISC OS custom event structure.
*/
169
170
171
struct SDL_SysWMmsg
{
SDL_version version;
172
int eventCode; /**< The window for the message */
173
int pollBlock[64];
174
175
};
176
177
178
/**
* The RISC OS custom window manager information structure.
*/
179
180
181
struct SDL_SysWMinfo
{
SDL_version version;
182
183
184
int wimpVersion; /**< Wimp version running under */
int taskHandle; /**< The RISC OS task handle */
int window; /**< The RISC OS display window */
185
};
186
187
#elif defined(SDL_VIDEO_DRIVER_PHOTON) || defined(SDL_VIDEO_DRIVER_QNXGF)
188
#include <sys/neutrino.h>
189
190
191
#if defined(SDL_VIDEO_OPENGL_ES)
#include <gf/gf.h>
#endif /* SDL_VIDEO_OPENGL_ES */
192
193
#include <Ph.h>
194
195
196
/**
* The QNX custom event structure.
*/
197
198
199
200
struct SDL_SysWMmsg
{
SDL_version version;
int data;
201
202
};
203
204
205
/**
* The QNX Photon custom window manager information structure.
*/
206
207
208
209
210
struct SDL_SysWMinfo
{
SDL_version version;
int data;
};
211
212
213
#else
214
215
216
/**
* The generic custom event structure.
*/
217
218
219
220
struct SDL_SysWMmsg
{
SDL_version version;
int data;
221
222
};
223
224
225
/**
* The generic custom window manager information structure.
*/
226
227
228
229
230
struct SDL_SysWMinfo
{
SDL_version version;
int data;
};
231
232
#endif /* video driver type */
233
234
235
#endif /* SDL_PROTOTYPES_ONLY */
236
237
typedef struct SDL_SysWMinfo SDL_SysWMinfo;
238
/* Function prototypes */
239
/**
240
241
* \brief This function allows access to driver-dependent window information.
*
242
* \param window The window about which information is being requested
243
244
245
246
247
248
249
250
* \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
251
* SDL_SysWMinfo info;
252
253
254
* SDL_VERSION(&info.version);
* if ( SDL_GetWindowWMInfo(&info) ) { ... }
* \endcode
255
*/
256
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
257
SDL_SysWMinfo * info);
258
259
260
261
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
262
/* *INDENT-OFF* */
263
}
264
/* *INDENT-ON* */
265
266
267
268
#endif
#include "close_code.h"
#endif /* _SDL_syswm_h */
269
270
/* vi: set ts=4 sw=4 expandtab: */