This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_syswm.h
230 lines (194 loc) · 6.04 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2009 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
27
/**
* \file SDL_syswm.h
*
* Include file for SDL custom system window manager hooks
*/
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
45
46
47
48
49
50
51
52
53
#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;
#else
54
/* This is the structure for custom window manager events */
55
#if defined(SDL_VIDEO_DRIVER_X11)
56
#if defined(__APPLE__) && defined(__MACH__)
57
/* conflicts with Quickdraw.h */
58
59
60
#define Cursor X11Cursor
#endif
61
62
63
#include <X11/Xlib.h>
#include <X11/Xatom.h>
64
#if defined(__APPLE__) && defined(__MACH__)
65
/* matches the re-define above */
66
67
68
#undef Cursor
#endif
69
/* These are the various supported subsystems under UNIX */
70
71
72
typedef enum
{
SDL_SYSWM_X11
73
74
75
} SDL_SYSWM_TYPE;
/* The UNIX custom event structure */
76
77
78
79
80
81
82
83
struct SDL_SysWMmsg
{
SDL_version version;
SDL_SYSWM_TYPE subsystem;
union
{
XEvent xevent;
} event;
84
85
86
87
88
89
};
/* 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.
*/
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
struct SDL_SysWMinfo
{
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;
};
114
115
#elif defined(SDL_VIDEO_DRIVER_WIN32)
116
117
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
118
119
/* The windows custom event structure */
120
121
122
123
124
125
126
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 */
127
128
129
};
/* The windows custom window manager information structure */
130
131
132
133
134
struct SDL_SysWMinfo
{
SDL_version version;
HWND window; /* The Win32 display window */
};
135
136
#elif defined(SDL_VIDEO_DRIVER_RISCOS)
137
138
/* RISC OS custom event structure */
139
140
141
142
143
struct SDL_SysWMmsg
{
SDL_version version;
int eventCode; /* The window for the message */
int pollBlock[64];
144
145
};
146
/* The RISC OS custom window manager information structure */
147
148
149
150
151
152
153
struct SDL_SysWMinfo
{
SDL_version version;
int wimpVersion; /* Wimp version running under */
int taskHandle; /* The RISC OS task handle */
int window; /* The RISC OS display window */
};
154
155
#elif defined(SDL_VIDEO_DRIVER_PHOTON) || defined(SDL_VIDEO_DRIVER_QNXGF)
156
#include <sys/neutrino.h>
157
158
159
#if defined(SDL_VIDEO_OPENGL_ES)
#include <gf/gf.h>
#endif /* SDL_VIDEO_OPENGL_ES */
160
161
162
#include <Ph.h>
/* The QNX custom event structure */
163
164
165
166
struct SDL_SysWMmsg
{
SDL_version version;
int data;
167
168
};
169
/* The QNX Photon custom window manager information structure */
170
171
172
173
174
struct SDL_SysWMinfo
{
SDL_version version;
int data;
};
175
176
177
178
#else
/* The generic custom event structure */
179
180
181
182
struct SDL_SysWMmsg
{
SDL_version version;
int data;
183
184
185
};
/* The generic custom window manager information structure */
186
187
188
189
190
struct SDL_SysWMinfo
{
SDL_version version;
int data;
};
191
192
#endif /* video driver type */
193
194
195
#endif /* SDL_PROTOTYPES_ONLY */
196
197
typedef struct SDL_SysWMinfo SDL_SysWMinfo;
198
/* Function prototypes */
199
200
201
202
203
204
205
206
207
/**
* \fn SDL_bool SDL_GetWindowWMInfo (SDL_WindowID windowID, SDL_SysWMinfo * info)
*
* \brief This function allows access to driver-dependent window information.
*
* \param windowID The window about which information is being requested
* \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 'info' struct is valid, SDL_FALSE otherwise.
208
209
*
* You typically use this function like this:
210
* \code
211
212
* SDL_SysWMInfo info;
* SDL_VERSION(&info.version);
213
214
* if ( SDL_GetWindowWMInfo(&info) ) { ... }
* \endcode
215
*/
216
217
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
SDL_SysWMinfo * info);
218
219
220
221
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
222
/* *INDENT-OFF* */
223
}
224
/* *INDENT-ON* */
225
226
227
228
#endif
#include "close_code.h"
#endif /* _SDL_syswm_h */
229
230
/* vi: set ts=4 sw=4 expandtab: */