2 Simple DirectMedia Layer
3 Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
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.
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:
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.
25 * Include file for SDL custom system window manager hooks.
31 #include "SDL_stdinc.h"
32 #include "SDL_error.h"
33 #include "SDL_video.h"
34 #include "SDL_version.h"
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().
46 #if !defined(SDL_PROTOTYPES_ONLY)
48 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
49 #ifndef WIN32_LEAN_AND_MEAN
50 #define WIN32_LEAN_AND_MEAN
52 #ifndef NOMINMAX /* don't define min() and max(). */
58 #if defined(SDL_VIDEO_DRIVER_WINRT)
59 #include <Inspectable.h>
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
70 #include <X11/Xatom.h>
72 #if defined(__APPLE__) && defined(__MACH__)
73 /* matches the re-define above */
77 #endif /* defined(SDL_VIDEO_DRIVER_X11) */
79 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
83 #if defined(SDL_VIDEO_DRIVER_COCOA)
87 typedef struct _NSWindow NSWindow;
91 #if defined(SDL_VIDEO_DRIVER_UIKIT)
93 #include <UIKit/UIKit.h>
95 typedef struct _UIWindow UIWindow;
96 typedef struct _UIViewController UIViewController;
98 typedef Uint32 GLuint;
101 #if defined(SDL_VIDEO_VULKAN) || defined(SDL_VIDEO_METAL)
102 #define SDL_METALVIEW_TAG 255
105 #if defined(SDL_VIDEO_DRIVER_ANDROID)
106 typedef struct ANativeWindow ANativeWindow;
107 typedef void *EGLSurface;
110 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
114 #if defined(SDL_VIDEO_DRIVER_OS2)
118 #endif /* SDL_PROTOTYPES_ONLY */
120 #if defined(SDL_VIDEO_DRIVER_KMSDRM)
125 #include "begin_code.h"
126 /* Set up for C function definitions, even when using C++ */
131 #if !defined(SDL_PROTOTYPES_ONLY)
133 * These are the various supported windowing subsystems
144 SDL_SYSWM_MIR, /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
155 * The custom event structure.
160 SDL_SYSWM_TYPE subsystem;
163 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
165 HWND hwnd; /**< The window for the message */
166 UINT msg; /**< The type of message */
167 WPARAM wParam; /**< WORD message parameter */
168 LPARAM lParam; /**< LONG message parameter */
171 #if defined(SDL_VIDEO_DRIVER_X11)
176 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
181 #if defined(SDL_VIDEO_DRIVER_COCOA)
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++
188 /* No Cocoa window events yet */
191 #if defined(SDL_VIDEO_DRIVER_UIKIT)
195 /* No UIKit window events yet */
198 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
202 /* No Vivante window events yet */
205 #if defined(SDL_VIDEO_DRIVER_OS2)
208 BOOL fFrame; /**< TRUE if hwnd is a frame window */
209 HWND hwnd; /**< The window receiving the message */
210 ULONG msg; /**< The message identifier */
211 MPARAM mp1; /**< The first first message parameter */
212 MPARAM mp2; /**< The second first message parameter */
215 /* Can't have an empty union */
221 * The custom window manager information structure.
223 * When this structure is returned, it holds information about which
224 * low level system it is using, and will be one of SDL_SYSWM_TYPE.
229 SDL_SYSWM_TYPE subsystem;
232 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
235 HWND window; /**< The window handle */
236 HDC hdc; /**< The window device context */
237 HINSTANCE hinstance; /**< The instance handle */
240 #if defined(SDL_VIDEO_DRIVER_WINRT)
243 IInspectable * window; /**< The WinRT CoreWindow */
246 #if defined(SDL_VIDEO_DRIVER_X11)
249 Display *display; /**< The X11 display */
250 Window window; /**< The X11 window */
253 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
256 IDirectFB *dfb; /**< The directfb main interface */
257 IDirectFBWindow *window; /**< The directfb window handle */
258 IDirectFBSurface *surface; /**< The directfb client surface */
261 #if defined(SDL_VIDEO_DRIVER_COCOA)
264 #if defined(__OBJC__) && defined(__has_feature)
265 #if __has_feature(objc_arc)
266 NSWindow __unsafe_unretained *window; /**< The Cocoa window */
268 NSWindow *window; /**< The Cocoa window */
271 NSWindow *window; /**< The Cocoa window */
275 #if defined(SDL_VIDEO_DRIVER_UIKIT)
278 #if defined(__OBJC__) && defined(__has_feature)
279 #if __has_feature(objc_arc)
280 UIWindow __unsafe_unretained *window; /**< The UIKit window */
282 UIWindow *window; /**< The UIKit window */
285 UIWindow *window; /**< The UIKit window */
287 GLuint framebuffer; /**< The GL view's Framebuffer Object. It must be bound when rendering to the screen using GL. */
288 GLuint colorbuffer; /**< The GL view's color Renderbuffer Object. It must be bound when SDL_GL_SwapWindow is called. */
289 GLuint resolveFramebuffer; /**< The Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used. */
292 #if defined(SDL_VIDEO_DRIVER_WAYLAND)
295 struct wl_display *display; /**< Wayland display */
296 struct wl_surface *surface; /**< Wayland surface */
297 void *shell_surface; /**< DEPRECATED Wayland shell_surface (window manager handle) */
298 struct wl_egl_window *egl_window; /**< Wayland EGL window (native window) */
299 struct xdg_surface *xdg_surface; /**< Wayland xdg surface (window manager handle) */
300 struct xdg_toplevel *xdg_toplevel; /**< Wayland xdg toplevel role */
301 struct xdg_popup *xdg_popup; /**< Wayland xdg popup role */
302 struct xdg_positioner *xdg_positioner; /**< Wayland xdg positioner, for popup */
305 #if defined(SDL_VIDEO_DRIVER_MIR) /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
308 void *connection; /**< Mir display server connection */
309 void *surface; /**< Mir surface */
313 #if defined(SDL_VIDEO_DRIVER_ANDROID)
316 ANativeWindow *window;
321 #if defined(SDL_VIDEO_DRIVER_OS2)
324 HWND hwnd; /**< The window handle */
325 HWND hwndFrame; /**< The frame window handle */
329 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
332 EGLNativeDisplayType display;
333 EGLNativeWindowType window;
337 #if defined(SDL_VIDEO_DRIVER_KMSDRM)
340 int dev_index; /**< Device index (ex: the X in /dev/dri/cardX) */
341 int drm_fd; /**< DRM FD (unavailable on Vulkan windows) */
342 struct gbm_device *gbm_dev; /**< GBM device (unavailable on Vulkan windows) */
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! */
352 #endif /* SDL_PROTOTYPES_ONLY */
354 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
358 * Get driver-specific information about a window.
360 * You must include SDL_syswm.h for the declaration of SDL_SysWMinfo.
362 * The caller must initialize the `info` structure's version by using
363 * `SDL_VERSION(&info.version)`, and then this function will fill in the rest
364 * of the structure with information about the given window.
366 * \param window the window about which information is being requested
367 * \param info an SDL_SysWMinfo structure filled in with window information
368 * \returns SDL_TRUE if the function is implemented and the `version` member
369 * of the `info` struct is valid, or SDL_FALSE if the information
370 * could not be retrieved; call SDL_GetError() for more information.
372 * \since This function is available since SDL 2.0.0.
374 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
375 SDL_SysWMinfo * info);
378 /* Ends C function definitions when using C++ */
382 #include "close_code.h"
384 #endif /* SDL_syswm_h_ */
386 /* vi: set ts=4 sw=4 expandtab: */