SDL_syswm.h
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 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.
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
27
*/
/* Include file for SDL custom system window manager hooks */
#ifndef _SDL_syswm_h
#define _SDL_syswm_h
28
#include "SDL_stdinc.h"
29
#include "SDL_error.h"
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#include "SDL_version.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/* 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()
*/
#ifdef SDL_PROTOTYPES_ONLY
struct SDL_SysWMinfo;
typedef struct SDL_SysWMinfo SDL_SysWMinfo;
#else
48
49
/* This is the structure for custom window manager events */
#if SDL_VIDEO_DRIVER_X11
50
51
52
53
54
#if defined(__APPLE__) && defined(__MACH__)
// conflicts with Quickdraw.h
#define Cursor X11Cursor
#endif
55
56
57
#include <X11/Xlib.h>
#include <X11/Xatom.h>
58
59
60
61
62
#if defined(__APPLE__) && defined(__MACH__)
// matches the re-define above
#undef Cursor
#endif
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/* These are the various supported subsystems under UNIX */
typedef enum {
SDL_SYSWM_X11
} SDL_SYSWM_TYPE;
/* The UNIX custom event structure */
struct SDL_SysWMmsg {
SDL_version version;
SDL_SYSWM_TYPE subsystem;
union {
XEvent xevent;
} event;
};
/* 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.
*/
81
typedef struct SDL_SysWMinfo {
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
SDL_version version;
SDL_SYSWM_TYPE subsystem;
union {
struct {
Display *display; /* The X11 display */
Window window; /* The X11 display window */
/* These locking functions should be called around
any X11 functions using the display variable.
They lock the event thread, so should not be
called around event functions or from event filters.
*/
void (*lock_func)(void);
void (*unlock_func)(void);
/* Introduced in SDL 1.0.2 */
Window fswindow; /* The X11 fullscreen window */
Window wmwindow; /* The X11 managed input window */
} x11;
} info;
} SDL_SysWMinfo;
103
#elif SDL_VIDEO_DRIVER_NANOX
104
105
106
107
108
109
110
111
112
#include <microwin/nano-X.h>
/* The generic custom event structure */
struct SDL_SysWMmsg {
SDL_version version;
int data;
};
/* The windows custom window manager information structure */
113
typedef struct SDL_SysWMinfo {
114
115
116
117
SDL_version version ;
GR_WINDOW_ID window ; /* The display window */
} SDL_SysWMinfo;
118
#elif SDL_VIDEO_DRIVER_WINDIB || SDL_VIDEO_DRIVER_DDRAW
119
#include "SDL_windows.h"
120
121
122
123
124
125
126
127
128
129
130
/* The windows custom event structure */
struct SDL_SysWMmsg {
SDL_version version;
HWND hwnd; /* The window for the message */
UINT msg; /* The type of message */
WPARAM wParam; /* WORD message parameter */
LPARAM lParam; /* LONG message parameter */
};
/* The windows custom window manager information structure */
131
typedef struct SDL_SysWMinfo {
132
133
SDL_version version;
HWND window; /* The Win32 display window */
134
HGLRC hglrc; /* The OpenGL context, if any */
135
136
} SDL_SysWMinfo;
137
#elif SDL_VIDEO_DRIVER_RISCOS
138
139
140
141
142
143
144
145
/* RISC OS custom event structure */
struct SDL_SysWMmsg {
SDL_version version;
int eventCode; /* The window for the message */
int pollBlock[64];
};
146
/* The RISC OS custom window manager information structure */
147
typedef struct SDL_SysWMinfo {
148
149
SDL_version version;
int wimpVersion; /* Wimp version running under */
150
151
int taskHandle; /* The RISC OS task handle */
int window; /* The RISC OS display window */
152
153
} SDL_SysWMinfo;
154
#elif SDL_VIDEO_DRIVER_PHOTON
155
156
157
158
159
160
161
162
163
164
#include <sys/neutrino.h>
#include <Ph.h>
/* The QNX custom event structure */
struct SDL_SysWMmsg {
SDL_version version;
int data;
};
/* The QNX custom window manager information structure */
165
typedef struct SDL_SysWMinfo {
166
167
168
169
SDL_version version;
int data;
} SDL_SysWMinfo;
170
171
172
173
174
175
176
177
178
#else
/* The generic custom event structure */
struct SDL_SysWMmsg {
SDL_version version;
int data;
};
/* The generic custom window manager information structure */
179
typedef struct SDL_SysWMinfo {
180
181
182
183
SDL_version version;
int data;
} SDL_SysWMinfo;
184
#endif /* video driver type */
185
186
187
188
189
190
191
192
193
#endif /* SDL_PROTOTYPES_ONLY */
/* Function prototypes */
/*
* This function gives you custom hooks into the window manager information.
* It fills the structure pointed to by 'info' with custom information and
* returns 1 if the function is implemented. If it's not implemented, or
* the version member of the 'info' structure is invalid, it returns 0.
194
195
196
197
198
*
* You typically use this function like this:
* SDL_SysWMInfo info;
* SDL_VERSION(&info.version);
* if ( SDL_GetWMInfo(&info) ) { ... }
199
*/
200
extern DECLSPEC int SDLCALL SDL_GetWMInfo(SDL_SysWMinfo *info);
201
202
203
204
205
206
207
208
209
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* _SDL_syswm_h */