SDL  2.0
SDL_syswm.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 
22 /**
23  * \file SDL_syswm.h
24  *
25  * Include file for SDL custom system window manager hooks.
26  */
27 
28 #ifndef _SDL_syswm_h
29 #define _SDL_syswm_h
30 
31 #include "SDL_stdinc.h"
32 #include "SDL_error.h"
33 #include "SDL_video.h"
34 #include "SDL_version.h"
35 
36 #include "begin_code.h"
37 /* Set up for C function definitions, even when using C++ */
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 /**
43  * \file SDL_syswm.h
44  *
45  * Your application has access to a special type of event ::SDL_SYSWMEVENT,
46  * which contains window-manager specific information and arrives whenever
47  * an unhandled window event occurs. This event is ignored by default, but
48  * you can enable it with SDL_EventState().
49  */
50 #ifdef SDL_PROTOTYPES_ONLY
51 struct SDL_SysWMinfo;
52 #else
53 
54 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
55 #ifndef WIN32_LEAN_AND_MEAN
56 #define WIN32_LEAN_AND_MEAN
57 #endif
58 #include <windows.h>
59 #endif
60 
61 #if defined(SDL_VIDEO_DRIVER_WINRT)
62 #include <Inspectable.h>
63 #endif
64 
65 /* This is the structure for custom window manager events */
66 #if defined(SDL_VIDEO_DRIVER_X11)
67 #if defined(__APPLE__) && defined(__MACH__)
68 /* conflicts with Quickdraw.h */
69 #define Cursor X11Cursor
70 #endif
71 
72 #include <X11/Xlib.h>
73 #include <X11/Xatom.h>
74 
75 #if defined(__APPLE__) && defined(__MACH__)
76 /* matches the re-define above */
77 #undef Cursor
78 #endif
79 
80 #endif /* defined(SDL_VIDEO_DRIVER_X11) */
81 
82 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
83 #include <directfb.h>
84 #endif
85 
86 #if defined(SDL_VIDEO_DRIVER_COCOA)
87 #ifdef __OBJC__
88 @class NSWindow;
89 #else
90 typedef struct _NSWindow NSWindow;
91 #endif
92 #endif
93 
94 #if defined(SDL_VIDEO_DRIVER_UIKIT)
95 #ifdef __OBJC__
96 #include <UIKit/UIKit.h>
97 #else
98 typedef struct _UIWindow UIWindow;
99 typedef struct _UIViewController UIViewController;
100 #endif
101 typedef Uint32 GLuint;
102 #endif
103 
104 #if defined(SDL_VIDEO_DRIVER_ANDROID)
105 typedef struct ANativeWindow ANativeWindow;
106 typedef void *EGLSurface;
107 #endif
108 
109 /**
110  * These are the various supported windowing subsystems
111  */
112 typedef enum
113 {
125 
126 /**
127  * The custom event structure.
128  */
130 {
132  SDL_SYSWM_TYPE subsystem;
133  union
134  {
135 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
136  struct {
137  HWND hwnd; /**< The window for the message */
138  UINT msg; /**< The type of message */
139  WPARAM wParam; /**< WORD message parameter */
140  LPARAM lParam; /**< LONG message parameter */
141  } win;
142 #endif
143 #if defined(SDL_VIDEO_DRIVER_X11)
144  struct {
145  XEvent event;
146  } x11;
147 #endif
148 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
149  struct {
150  DFBEvent event;
151  } dfb;
152 #endif
153 #if defined(SDL_VIDEO_DRIVER_COCOA)
154  struct
155  {
156  /* Latest version of Xcode clang complains about empty structs in C v. C++:
157  error: empty struct has size 0 in C, size 1 in C++
158  */
159  int dummy;
160  /* No Cocoa window events yet */
161  } cocoa;
162 #endif
163 #if defined(SDL_VIDEO_DRIVER_UIKIT)
164  struct
165  {
166  int dummy;
167  /* No UIKit window events yet */
168  } uikit;
169 #endif
170  /* Can't have an empty union */
171  int dummy;
172  } msg;
173 };
174 
175 /**
176  * The custom window manager information structure.
177  *
178  * When this structure is returned, it holds information about which
179  * low level system it is using, and will be one of SDL_SYSWM_TYPE.
180  */
182 {
184  SDL_SYSWM_TYPE subsystem;
185  union
186  {
187 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
188  struct
189  {
190  HWND window; /**< The window handle */
191  HDC hdc; /**< The window device context */
192  } win;
193 #endif
194 #if defined(SDL_VIDEO_DRIVER_WINRT)
195  struct
196  {
197  IInspectable * window; /**< The WinRT CoreWindow */
198  } winrt;
199 #endif
200 #if defined(SDL_VIDEO_DRIVER_X11)
201  struct
202  {
203  Display *display; /**< The X11 display */
204  Window window; /**< The X11 window */
205  } x11;
206 #endif
207 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
208  struct
209  {
210  IDirectFB *dfb; /**< The directfb main interface */
211  IDirectFBWindow *window; /**< The directfb window handle */
212  IDirectFBSurface *surface; /**< The directfb client surface */
213  } dfb;
214 #endif
215 #if defined(SDL_VIDEO_DRIVER_COCOA)
216  struct
217  {
218 #if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
219  NSWindow __unsafe_unretained *window; /* The Cocoa window */
220 #else
221  NSWindow *window; /* The Cocoa window */
222 #endif
223  } cocoa;
224 #endif
225 #if defined(SDL_VIDEO_DRIVER_UIKIT)
226  struct
227  {
228 #if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
229  UIWindow __unsafe_unretained *window; /* The UIKit window */
230 #else
231  UIWindow *window; /* The UIKit window */
232 #endif
233  GLuint framebuffer; /* The GL view's Framebuffer Object. It must be bound when rendering to the screen using GL. */
234  GLuint colorbuffer; /* The GL view's color Renderbuffer Object. It must be bound when SDL_GL_SwapWindow is called. */
235  GLuint resolveFramebuffer; /* The Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used. */
236  } uikit;
237 #endif
238 #if defined(SDL_VIDEO_DRIVER_WAYLAND)
239  struct
240  {
241  struct wl_display *display; /**< Wayland display */
242  struct wl_surface *surface; /**< Wayland surface */
243  struct wl_shell_surface *shell_surface; /**< Wayland shell_surface (window manager handle) */
244  } wl;
245 #endif
246 #if defined(SDL_VIDEO_DRIVER_MIR)
247  struct
248  {
249  struct MirConnection *connection; /**< Mir display server connection */
250  struct MirSurface *surface; /**< Mir surface */
251  } mir;
252 #endif
253 
254 #if defined(SDL_VIDEO_DRIVER_ANDROID)
255  struct
256  {
257  ANativeWindow *window;
258  EGLSurface surface;
259  } android;
260 #endif
261 
262  /* Can't have an empty union */
263  int dummy;
264  } info;
265 };
266 
267 #endif /* SDL_PROTOTYPES_ONLY */
268 
269 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
270 
271 /* Function prototypes */
272 /**
273  * \brief This function allows access to driver-dependent window information.
274  *
275  * \param window The window about which information is being requested
276  * \param info This structure must be initialized with the SDL version, and is
277  * then filled in with information about the given window.
278  *
279  * \return SDL_TRUE if the function is implemented and the version member of
280  * the \c info struct is valid, SDL_FALSE otherwise.
281  *
282  * You typically use this function like this:
283  * \code
284  * SDL_SysWMinfo info;
285  * SDL_VERSION(&info.version);
286  * if ( SDL_GetWindowWMInfo(window, &info) ) { ... }
287  * \endcode
288  */
290  SDL_SysWMinfo * info);
291 
292 
293 /* Ends C function definitions when using C++ */
294 #ifdef __cplusplus
295 }
296 #endif
297 #include "close_code.h"
298 
299 #endif /* _SDL_syswm_h */
300 
301 /* vi: set ts=4 sw=4 expandtab: */
SDL_version version
Definition: SDL_syswm.h:131
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:155
Display * display
Definition: SDL_syswm.h:203
SDL_Window * window
SDL_SYSWM_TYPE
Definition: SDL_syswm.h:112
SDL_version version
Definition: SDL_syswm.h:183
SDL_SYSWM_TYPE subsystem
Definition: SDL_syswm.h:184
union SDL_SysWMmsg::@16 msg
SDL_bool
Definition: SDL_stdinc.h:126
#define DECLSPEC
Definition: SDL_internal.h:30
Information the version of SDL in use.
Definition: SDL_version.h:51
SDL_SYSWM_TYPE subsystem
Definition: SDL_syswm.h:132
Window window
Definition: SDL_syswm.h:204
GLuint framebuffer
unsigned int GLuint
Definition: SDL_opengl.h:178
struct SDL_SysWMmsg::@16::@17 x11
The type used to identify a window.
Definition: SDL_sysvideo.h:71
XEvent event
Definition: SDL_syswm.h:145
union SDL_SysWMinfo::@18 info
SDL_bool SDL_GetWindowWMInfo(SDL_Window *window, SDL_SysWMinfo *info)
This function allows access to driver-dependent window information.
Definition: SDL_video.c:3379
#define SDLCALL
Definition: SDL_internal.h:31