SDL  2.0
SDL_syswm.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2021 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 /**
37  * \brief SDL_syswm.h
38  *
39  * Your application has access to a special type of event ::SDL_SYSWMEVENT,
40  * which contains window-manager specific information and arrives whenever
41  * an unhandled window event occurs. This event is ignored by default, but
42  * you can enable it with SDL_EventState().
43  */
44 struct SDL_SysWMinfo;
45 
46 #if !defined(SDL_PROTOTYPES_ONLY)
47 
48 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
49 #ifndef WIN32_LEAN_AND_MEAN
50 #define WIN32_LEAN_AND_MEAN
51 #endif
52 #ifndef NOMINMAX /* don't define min() and max(). */
53 #define NOMINMAX
54 #endif
55 #include <windows.h>
56 #endif
57 
58 #if defined(SDL_VIDEO_DRIVER_WINRT)
59 #include <Inspectable.h>
60 #endif
61 
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 #define Cursor X11Cursor
67 #endif
68 
69 #include <X11/Xlib.h>
70 #include <X11/Xatom.h>
71 
72 #if defined(__APPLE__) && defined(__MACH__)
73 /* matches the re-define above */
74 #undef Cursor
75 #endif
76 
77 #endif /* defined(SDL_VIDEO_DRIVER_X11) */
78 
79 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
80 #include <directfb.h>
81 #endif
82 
83 #if defined(SDL_VIDEO_DRIVER_COCOA)
84 #ifdef __OBJC__
85 @class NSWindow;
86 #else
87 typedef struct _NSWindow NSWindow;
88 #endif
89 #endif
90 
91 #if defined(SDL_VIDEO_DRIVER_UIKIT)
92 #ifdef __OBJC__
93 #include <UIKit/UIKit.h>
94 #else
95 typedef struct _UIWindow UIWindow;
96 typedef struct _UIViewController UIViewController;
97 #endif
98 typedef Uint32 GLuint;
99 #endif
100 
101 #if defined(SDL_VIDEO_DRIVER_ANDROID)
102 typedef struct ANativeWindow ANativeWindow;
103 typedef void *EGLSurface;
104 #endif
105 
106 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
107 #include "SDL_egl.h"
108 #endif
109 
110 #if defined(SDL_VIDEO_DRIVER_OS2)
111 #define INCL_WIN
112 #include <os2.h>
113 #endif
114 #endif /* SDL_PROTOTYPES_ONLY */
115 
116 #if defined(SDL_VIDEO_DRIVER_KMSDRM)
117 struct gbm_device;
118 #endif
119 
120 
121 #include "begin_code.h"
122 /* Set up for C function definitions, even when using C++ */
123 #ifdef __cplusplus
124 extern "C" {
125 #endif
126 
127 #if !defined(SDL_PROTOTYPES_ONLY)
128 /**
129  * These are the various supported windowing subsystems
130  */
131 typedef enum
132 {
140  SDL_SYSWM_MIR, /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
149 
150 /**
151  * The custom event structure.
152  */
154 {
157  union
158  {
159 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
160  struct {
161  HWND hwnd; /**< The window for the message */
162  UINT msg; /**< The type of message */
163  WPARAM wParam; /**< WORD message parameter */
164  LPARAM lParam; /**< LONG message parameter */
165  } win;
166 #endif
167 #if defined(SDL_VIDEO_DRIVER_X11)
168  struct {
169  XEvent event;
170  } x11;
171 #endif
172 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
173  struct {
174  DFBEvent event;
175  } dfb;
176 #endif
177 #if defined(SDL_VIDEO_DRIVER_COCOA)
178  struct
179  {
180  /* Latest version of Xcode clang complains about empty structs in C v. C++:
181  error: empty struct has size 0 in C, size 1 in C++
182  */
183  int dummy;
184  /* No Cocoa window events yet */
185  } cocoa;
186 #endif
187 #if defined(SDL_VIDEO_DRIVER_UIKIT)
188  struct
189  {
190  int dummy;
191  /* No UIKit window events yet */
192  } uikit;
193 #endif
194 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
195  struct
196  {
197  int dummy;
198  /* No Vivante window events yet */
199  } vivante;
200 #endif
201 #if defined(SDL_VIDEO_DRIVER_OS2)
202  struct
203  {
204  BOOL fFrame; /**< TRUE if hwnd is a frame window */
205  HWND hwnd; /**< The window receiving the message */
206  ULONG msg; /**< The message identifier */
207  MPARAM mp1; /**< The first first message parameter */
208  MPARAM mp2; /**< The second first message parameter */
209  } os2;
210 #endif
211  /* Can't have an empty union */
212  int dummy;
213  } msg;
214 };
215 
216 /**
217  * The custom window manager information structure.
218  *
219  * When this structure is returned, it holds information about which
220  * low level system it is using, and will be one of SDL_SYSWM_TYPE.
221  */
223 {
226  union
227  {
228 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
229  struct
230  {
231  HWND window; /**< The window handle */
232  HDC hdc; /**< The window device context */
233  HINSTANCE hinstance; /**< The instance handle */
234  } win;
235 #endif
236 #if defined(SDL_VIDEO_DRIVER_WINRT)
237  struct
238  {
239  IInspectable * window; /**< The WinRT CoreWindow */
240  } winrt;
241 #endif
242 #if defined(SDL_VIDEO_DRIVER_X11)
243  struct
244  {
245  Display *display; /**< The X11 display */
246  Window window; /**< The X11 window */
247  } x11;
248 #endif
249 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
250  struct
251  {
252  IDirectFB *dfb; /**< The directfb main interface */
253  IDirectFBWindow *window; /**< The directfb window handle */
254  IDirectFBSurface *surface; /**< The directfb client surface */
255  } dfb;
256 #endif
257 #if defined(SDL_VIDEO_DRIVER_COCOA)
258  struct
259  {
260 #if defined(__OBJC__) && defined(__has_feature)
261  #if __has_feature(objc_arc)
262  NSWindow __unsafe_unretained *window; /**< The Cocoa window */
263  #else
264  NSWindow *window; /**< The Cocoa window */
265  #endif
266 #else
267  NSWindow *window; /**< The Cocoa window */
268 #endif
269  } cocoa;
270 #endif
271 #if defined(SDL_VIDEO_DRIVER_UIKIT)
272  struct
273  {
274 #if defined(__OBJC__) && defined(__has_feature)
275  #if __has_feature(objc_arc)
276  UIWindow __unsafe_unretained *window; /**< The UIKit window */
277  #else
278  UIWindow *window; /**< The UIKit window */
279  #endif
280 #else
281  UIWindow *window; /**< The UIKit window */
282 #endif
283  GLuint framebuffer; /**< The GL view's Framebuffer Object. It must be bound when rendering to the screen using GL. */
284  GLuint colorbuffer; /**< The GL view's color Renderbuffer Object. It must be bound when SDL_GL_SwapWindow is called. */
285  GLuint resolveFramebuffer; /**< The Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used. */
286  } uikit;
287 #endif
288 #if defined(SDL_VIDEO_DRIVER_WAYLAND)
289  struct
290  {
291  struct wl_display *display; /**< Wayland display */
292  struct wl_surface *surface; /**< Wayland surface */
293  void *shell_surface; /**< DEPRECATED Wayland shell_surface (window manager handle) */
294  struct wl_egl_window *egl_window; /**< Wayland EGL window (native window) */
295  struct xdg_surface *xdg_surface; /**< Wayland xdg surface (window manager handle) */
296  struct xdg_toplevel *xdg_toplevel; /**< Wayland xdg toplevel role */
297  } wl;
298 #endif
299 #if defined(SDL_VIDEO_DRIVER_MIR) /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
300  struct
301  {
302  void *connection; /**< Mir display server connection */
303  void *surface; /**< Mir surface */
304  } mir;
305 #endif
306 
307 #if defined(SDL_VIDEO_DRIVER_ANDROID)
308  struct
309  {
310  ANativeWindow *window;
311  EGLSurface surface;
312  } android;
313 #endif
314 
315 #if defined(SDL_VIDEO_DRIVER_OS2)
316  struct
317  {
318  HWND hwnd; /**< The window handle */
319  HWND hwndFrame; /**< The frame window handle */
320  } os2;
321 #endif
322 
323 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
324  struct
325  {
326  EGLNativeDisplayType display;
327  EGLNativeWindowType window;
328  } vivante;
329 #endif
330 
331 #if defined(SDL_VIDEO_DRIVER_KMSDRM)
332  struct
333  {
334  int dev_index; /**< Device index (ex: the X in /dev/dri/cardX) */
335  int drm_fd; /**< DRM FD (unavailable on Vulkan windows) */
336  struct gbm_device *gbm_dev; /**< GBM device (unavailable on Vulkan windows) */
338 #endif
339 
340  /* Make sure this union is always 64 bytes (8 64-bit pointers). */
341  /* Be careful not to overflow this if you add a new target! */
343  } info;
344 };
345 
346 #endif /* SDL_PROTOTYPES_ONLY */
347 
348 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
349 
350 
351 /**
352  * Get driver-specific information about a window.
353  *
354  * You must include SDL_syswm.h for the declaration of SDL_SysWMinfo.
355  *
356  * The caller must initialize the `info` structure's version by using
357  * `SDL_VERSION(&info.version)`, and then this function will fill in the rest
358  * of the structure with information about the given window.
359  *
360  * \param window the window about which information is being requested
361  * \param info an SDL_SysWMinfo structure filled in with window information
362  * \returns SDL_TRUE if the function is implemented and the `version` member
363  * of the `info` struct is valid, or SDL_FALSE if the information
364  * could not be retrieved; call SDL_GetError() for more information.
365  *
366  * \since This function is available since SDL 2.0.0.
367  */
368 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
369  SDL_SysWMinfo * info);
370 
371 
372 /* Ends C function definitions when using C++ */
373 #ifdef __cplusplus
374 }
375 #endif
376 #include "close_code.h"
377 
378 #endif /* SDL_syswm_h_ */
379 
380 /* vi: set ts=4 sw=4 expandtab: */
uint8_t Uint8
Definition: SDL_stdinc.h:196
SDL_bool
Definition: SDL_stdinc.h:179
uint32_t Uint32
Definition: SDL_stdinc.h:220
SDL_SYSWM_TYPE
Definition: SDL_syswm.h:132
@ SDL_SYSWM_X11
Definition: SDL_syswm.h:135
@ SDL_SYSWM_DIRECTFB
Definition: SDL_syswm.h:136
@ SDL_SYSWM_RISCOS
Definition: SDL_syswm.h:147
@ SDL_SYSWM_UNKNOWN
Definition: SDL_syswm.h:133
@ SDL_SYSWM_OS2
Definition: SDL_syswm.h:144
@ SDL_SYSWM_HAIKU
Definition: SDL_syswm.h:145
@ SDL_SYSWM_KMSDRM
Definition: SDL_syswm.h:146
@ SDL_SYSWM_WINDOWS
Definition: SDL_syswm.h:134
@ SDL_SYSWM_UIKIT
Definition: SDL_syswm.h:138
@ SDL_SYSWM_COCOA
Definition: SDL_syswm.h:137
@ SDL_SYSWM_WAYLAND
Definition: SDL_syswm.h:139
@ SDL_SYSWM_VIVANTE
Definition: SDL_syswm.h:143
@ SDL_SYSWM_ANDROID
Definition: SDL_syswm.h:142
@ SDL_SYSWM_MIR
Definition: SDL_syswm.h:140
@ SDL_SYSWM_WINRT
Definition: SDL_syswm.h:141
SDL_bool SDL_GetWindowWMInfo(SDL_Window *window, SDL_SysWMinfo *info)
struct SDL_Window SDL_Window
The type used to identify a window.
Definition: SDL_video.h:95
struct gbm_device * gbm_dev
Definition: SDL_syswm.h:336
Uint8 dummy[64]
Definition: SDL_syswm.h:342
struct wl_display * display
Definition: SDL_syswm.h:291
struct SDL_SysWMinfo::@10::@13 kmsdrm
struct wl_surface * surface
Definition: SDL_syswm.h:292
union SDL_SysWMinfo::@10 info
struct SDL_SysWMinfo::@10::@12 wl
struct SDL_SysWMinfo::@10::@11 x11
SDL_SYSWM_TYPE subsystem
Definition: SDL_syswm.h:225
Display * display
Definition: SDL_syswm.h:245
void * shell_surface
Definition: SDL_syswm.h:293
Window window
Definition: SDL_syswm.h:246
struct xdg_surface * xdg_surface
Definition: SDL_syswm.h:295
struct wl_egl_window * egl_window
Definition: SDL_syswm.h:294
SDL_version version
Definition: SDL_syswm.h:224
struct xdg_toplevel * xdg_toplevel
Definition: SDL_syswm.h:296
union SDL_SysWMmsg::@8 msg
struct SDL_SysWMmsg::@8::@9 x11
SDL_SYSWM_TYPE subsystem
Definition: SDL_syswm.h:156
SDL_version version
Definition: SDL_syswm.h:155
XEvent event
Definition: SDL_syswm.h:169