This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_syswm.h
217 lines (191 loc) · 5.49 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
58
59
60
61
#if defined(SDL_VIDEO_DRIVER_WIN32)
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#endif
62
/* This is the structure for custom window manager events */
63
#if defined(SDL_VIDEO_DRIVER_X11)
64
#if defined(__APPLE__) && defined(__MACH__)
65
/* conflicts with Quickdraw.h */
66
67
68
#define Cursor X11Cursor
#endif
69
70
71
#include <X11/Xlib.h>
#include <X11/Xatom.h>
72
#if defined(__APPLE__) && defined(__MACH__)
73
/* matches the re-define above */
74
75
76
#undef Cursor
#endif
77
78
79
80
81
#endif /* defined(SDL_VIDEO_DRIVER_X11) */
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
#include <directfb/directfb.h>
#endif
82
83
84
85
86
87
88
89
90
#if defined(SDL_VIDEO_DRIVER_COCOA)
#ifdef __OBJC__
#include <Cocoa/Cocoa.h>
#else
typedef struct _NSWindow NSWindow;
#endif
#endif
91
/**
92
* These are the various supported windowing subsystems
93
*/
94
95
typedef enum
{
96
97
SDL_SYSWM_UNKNOWN,
SDL_SYSWM_WINDOWS,
98
99
SDL_SYSWM_X11,
SDL_SYSWM_DIRECTFB,
100
SDL_SYSWM_COCOA,
101
102
} SDL_SYSWM_TYPE;
103
/**
104
* The custom event structure.
105
*/
106
107
108
109
110
111
struct SDL_SysWMmsg
{
SDL_version version;
SDL_SYSWM_TYPE subsystem;
union
{
112
113
114
115
116
117
118
119
#if defined(SDL_VIDEO_DRIVER_WIN32)
struct {
HWND hwnd; /**< The window for the message */
UINT msg; /**< The type of message */
WPARAM wParam; /**< WORD message parameter */
LPARAM lParam; /**< LONG message parameter */
} win;
#endif
120
#if defined(SDL_VIDEO_DRIVER_X11)
121
122
123
struct {
XEvent event;
} x11;
124
125
#endif
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
126
127
128
struct {
DFBEvent event;
} dfb;
129
#endif
130
131
132
133
134
135
#if defined(SDL_VIDEO_DRIVER_COCOA)
struct
{
/* No Cocoa window events yet */
} cocoa;
#endif
136
} /*msg*/;
137
138
};
139
/**
140
* The custom window manager information structure.
141
142
143
*
* When this structure is returned, it holds information about which
* low level system it is using, and will be one of SDL_SYSWM_TYPE.
144
*/
145
146
147
148
149
150
struct SDL_SysWMinfo
{
SDL_version version;
SDL_SYSWM_TYPE subsystem;
union
{
151
152
153
#if defined(SDL_VIDEO_DRIVER_WIN32)
struct
{
154
HWND window; /**< The window handle */
155
156
} win;
#endif
157
#if defined(SDL_VIDEO_DRIVER_X11)
158
159
struct
{
160
Display *display; /**< The X11 display */
161
Window window; /**< The X11 window */
162
} x11;
163
164
165
166
#endif
#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
struct
{
167
168
169
IDirectFB *dfb; /**< The directfb main interface */
IDirectFBWindow *window; /**< The directfb window handle */
IDirectFBSurface *surface; /**< The directfb client surface */
170
171
172
173
174
} dfb;
#endif
#if defined(SDL_VIDEO_DRIVER_COCOA)
struct
{
175
NSWindow *window; /* The Cocoa window */
176
} cocoa;
177
#endif
178
} /*info*/;
179
};
180
181
182
#endif /* SDL_PROTOTYPES_ONLY */
183
184
typedef struct SDL_SysWMinfo SDL_SysWMinfo;
185
/* Function prototypes */
186
/**
187
188
* \brief This function allows access to driver-dependent window information.
*
189
* \param window The window about which information is being requested
190
191
192
193
194
195
196
197
* \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
198
* SDL_SysWMinfo info;
199
200
201
* SDL_VERSION(&info.version);
* if ( SDL_GetWindowWMInfo(&info) ) { ... }
* \endcode
202
*/
203
extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
204
SDL_SysWMinfo * info);
205
206
207
208
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
209
/* *INDENT-OFF* */
210
}
211
/* *INDENT-ON* */
212
213
214
215
#endif
#include "close_code.h"
#endif /* _SDL_syswm_h */
216
217
/* vi: set ts=4 sw=4 expandtab: */