My Project
Loading...
Searching...
No Matches
SDL_syswm.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2023 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
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
44struct 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
87typedef 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
95typedef struct _UIWindow UIWindow;
96typedef struct _UIViewController UIViewController;
97#endif
98typedef Uint32 GLuint;
99#endif
100
101#if defined(SDL_VIDEO_VULKAN) || defined(SDL_VIDEO_METAL)
102#define SDL_METALVIEW_TAG 255
103#endif
104
105#if defined(SDL_VIDEO_DRIVER_ANDROID)
106typedef struct ANativeWindow ANativeWindow;
107typedef void *EGLSurface;
108#endif
109
110#if defined(SDL_VIDEO_DRIVER_VIVANTE)
111#include "SDL_egl.h"
112#endif
113
114#if defined(SDL_VIDEO_DRIVER_OS2)
115#define INCL_WIN
116#include <os2.h>
117#endif
118#endif /* SDL_PROTOTYPES_ONLY */
119
120#if defined(SDL_VIDEO_DRIVER_KMSDRM)
121struct gbm_device;
122#endif
123
124
125#include "begin_code.h"
126/* Set up for C function definitions, even when using C++ */
127#ifdef __cplusplus
128extern "C" {
129#endif
130
131#if !defined(SDL_PROTOTYPES_ONLY)
135typedef enum
136{
137 SDL_SYSWM_UNKNOWN,
138 SDL_SYSWM_WINDOWS,
139 SDL_SYSWM_X11,
140 SDL_SYSWM_DIRECTFB,
141 SDL_SYSWM_COCOA,
142 SDL_SYSWM_UIKIT,
143 SDL_SYSWM_WAYLAND,
144 SDL_SYSWM_MIR, /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
145 SDL_SYSWM_WINRT,
146 SDL_SYSWM_ANDROID,
147 SDL_SYSWM_VIVANTE,
148 SDL_SYSWM_OS2,
149 SDL_SYSWM_HAIKU,
150 SDL_SYSWM_KMSDRM,
151 SDL_SYSWM_RISCOS
153
158{
159 SDL_version version;
160 SDL_SYSWM_TYPE subsystem;
161 union
162 {
163#if defined(SDL_VIDEO_DRIVER_WINDOWS)
164 struct {
165 HWND hwnd;
166 UINT msg;
167 WPARAM wParam;
168 LPARAM lParam;
169 } win;
170#endif
171#if defined(SDL_VIDEO_DRIVER_X11)
172 struct {
173 XEvent event;
174 } x11;
175#endif
176#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
177 struct {
178 DFBEvent event;
179 } dfb;
180#endif
181#if defined(SDL_VIDEO_DRIVER_COCOA)
182 struct
183 {
184 /* Latest version of Xcode clang complains about empty structs in C v. C++:
185 error: empty struct has size 0 in C, size 1 in C++
186 */
187 int dummy;
188 /* No Cocoa window events yet */
189 } cocoa;
190#endif
191#if defined(SDL_VIDEO_DRIVER_UIKIT)
192 struct
193 {
194 int dummy;
195 /* No UIKit window events yet */
196 } uikit;
197#endif
198#if defined(SDL_VIDEO_DRIVER_VIVANTE)
199 struct
200 {
201 int dummy;
202 /* No Vivante window events yet */
203 } vivante;
204#endif
205#if defined(SDL_VIDEO_DRIVER_OS2)
206 struct
207 {
208 BOOL fFrame;
209 HWND hwnd;
210 ULONG msg;
211 MPARAM mp1;
212 MPARAM mp2;
213 } os2;
214#endif
215 /* Can't have an empty union */
216 int dummy;
217 } msg;
218};
219
227{
228 SDL_version version;
229 SDL_SYSWM_TYPE subsystem;
230 union
231 {
232#if defined(SDL_VIDEO_DRIVER_WINDOWS)
233 struct
234 {
235 HWND window;
236 HDC hdc;
237 HINSTANCE hinstance;
238 } win;
239#endif
240#if defined(SDL_VIDEO_DRIVER_WINRT)
241 struct
242 {
243 IInspectable * window;
244 } winrt;
245#endif
246#if defined(SDL_VIDEO_DRIVER_X11)
247 struct
248 {
249 Display *display;
250 Window window;
251 } x11;
252#endif
253#if defined(SDL_VIDEO_DRIVER_DIRECTFB)
254 struct
255 {
256 IDirectFB *dfb;
257 IDirectFBWindow *window;
258 IDirectFBSurface *surface;
259 } dfb;
260#endif
261#if defined(SDL_VIDEO_DRIVER_COCOA)
262 struct
263 {
264#if defined(__OBJC__) && defined(__has_feature)
265 #if __has_feature(objc_arc)
266 NSWindow __unsafe_unretained *window;
267 #else
268 NSWindow *window;
269 #endif
270#else
271 NSWindow *window;
272#endif
273 } cocoa;
274#endif
275#if defined(SDL_VIDEO_DRIVER_UIKIT)
276 struct
277 {
278#if defined(__OBJC__) && defined(__has_feature)
279 #if __has_feature(objc_arc)
280 UIWindow __unsafe_unretained *window;
281 #else
282 UIWindow *window;
283 #endif
284#else
285 UIWindow *window;
286#endif
287 GLuint framebuffer;
288 GLuint colorbuffer;
289 GLuint resolveFramebuffer;
290 } uikit;
291#endif
292#if defined(SDL_VIDEO_DRIVER_WAYLAND)
293 struct
294 {
295 struct wl_display *display;
296 struct wl_surface *surface;
297 void *shell_surface;
298 struct wl_egl_window *egl_window;
299 struct xdg_surface *xdg_surface;
300 struct xdg_toplevel *xdg_toplevel;
301 struct xdg_popup *xdg_popup;
302 struct xdg_positioner *xdg_positioner;
303 } wl;
304#endif
305#if defined(SDL_VIDEO_DRIVER_MIR) /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
306 struct
307 {
308 void *connection;
309 void *surface;
310 } mir;
311#endif
312
313#if defined(SDL_VIDEO_DRIVER_ANDROID)
314 struct
315 {
316 ANativeWindow *window;
317 EGLSurface surface;
318 } android;
319#endif
320
321#if defined(SDL_VIDEO_DRIVER_OS2)
322 struct
323 {
324 HWND hwnd;
325 HWND hwndFrame;
326 } os2;
327#endif
328
329#if defined(SDL_VIDEO_DRIVER_VIVANTE)
330 struct
331 {
332 EGLNativeDisplayType display;
333 EGLNativeWindowType window;
334 } vivante;
335#endif
336
337#if defined(SDL_VIDEO_DRIVER_KMSDRM)
338 struct
339 {
340 int dev_index;
341 int drm_fd;
342 struct gbm_device *gbm_dev;
343 } kmsdrm;
344#endif
345
346 /* Make sure this union is always 64 bytes (8 64-bit pointers). */
347 /* Be careful not to overflow this if you add a new target! */
348 Uint8 dummy[64];
349 } info;
350};
351
352#endif /* SDL_PROTOTYPES_ONLY */
353
354typedef struct SDL_SysWMinfo SDL_SysWMinfo;
355
356
374extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
375 SDL_SysWMinfo * info);
376
377
378/* Ends C function definitions when using C++ */
379#ifdef __cplusplus
380}
381#endif
382#include "close_code.h"
383
384#endif /* SDL_syswm_h_ */
385
386/* vi: set ts=4 sw=4 expandtab: */
SDL_SYSWM_TYPE
Definition: SDL_syswm.h:136
DECLSPEC SDL_bool SDLCALL 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
Definition: SDL_syswm.h:227
HWND window
Definition: SDL_syswm.h:235
HINSTANCE hinstance
Definition: SDL_syswm.h:237
HDC hdc
Definition: SDL_syswm.h:236
Definition: SDL_syswm.h:158
WPARAM wParam
Definition: SDL_syswm.h:167
UINT msg
Definition: SDL_syswm.h:166
LPARAM lParam
Definition: SDL_syswm.h:168
HWND hwnd
Definition: SDL_syswm.h:165
Definition: SDL_version.h:52