2 Simple DirectMedia Layer
3 Copyright (C) 1997-2020 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_DRIVER_ANDROID)
102 typedef struct ANativeWindow ANativeWindow;
103 typedef void *EGLSurface;
106 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
110 #if defined(SDL_VIDEO_DRIVER_OS2)
114 #endif /* SDL_PROTOTYPES_ONLY */
117 #include "begin_code.h"
118 /* Set up for C function definitions, even when using C++ */
123 #if !defined(SDL_PROTOTYPES_ONLY)
125 * These are the various supported windowing subsystems
136 SDL_SYSWM_MIR, /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
146 * The custom event structure.
151 SDL_SYSWM_TYPE subsystem;
154 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
156 HWND hwnd; /**< The window for the message */
157 UINT msg; /**< The type of message */
158 WPARAM wParam; /**< WORD message parameter */
159 LPARAM lParam; /**< LONG message parameter */
162 #if defined(SDL_VIDEO_DRIVER_X11)
167 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
172 #if defined(SDL_VIDEO_DRIVER_COCOA)
175 /* Latest version of Xcode clang complains about empty structs in C v. C++:
176 error: empty struct has size 0 in C, size 1 in C++
179 /* No Cocoa window events yet */
182 #if defined(SDL_VIDEO_DRIVER_UIKIT)
186 /* No UIKit window events yet */
189 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
193 /* No Vivante window events yet */
196 #if defined(SDL_VIDEO_DRIVER_OS2)
199 BOOL fFrame; /**< TRUE if hwnd is a frame window */
200 HWND hwnd; /**< The window receiving the message */
201 ULONG msg; /**< The message identifier */
202 MPARAM mp1; /**< The first first message parameter */
203 MPARAM mp2; /**< The second first message parameter */
206 /* Can't have an empty union */
212 * The custom window manager information structure.
214 * When this structure is returned, it holds information about which
215 * low level system it is using, and will be one of SDL_SYSWM_TYPE.
220 SDL_SYSWM_TYPE subsystem;
223 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
226 HWND window; /**< The window handle */
227 HDC hdc; /**< The window device context */
228 HINSTANCE hinstance; /**< The instance handle */
231 #if defined(SDL_VIDEO_DRIVER_WINRT)
234 IInspectable * window; /**< The WinRT CoreWindow */
237 #if defined(SDL_VIDEO_DRIVER_X11)
240 Display *display; /**< The X11 display */
241 Window window; /**< The X11 window */
244 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
247 IDirectFB *dfb; /**< The directfb main interface */
248 IDirectFBWindow *window; /**< The directfb window handle */
249 IDirectFBSurface *surface; /**< The directfb client surface */
252 #if defined(SDL_VIDEO_DRIVER_COCOA)
255 #if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
256 NSWindow __unsafe_unretained *window; /**< The Cocoa window */
258 NSWindow *window; /**< The Cocoa window */
262 #if defined(SDL_VIDEO_DRIVER_UIKIT)
265 #if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
266 UIWindow __unsafe_unretained *window; /**< The UIKit window */
268 UIWindow *window; /**< The UIKit window */
270 GLuint framebuffer; /**< The GL view's Framebuffer Object. It must be bound when rendering to the screen using GL. */
271 GLuint colorbuffer; /**< The GL view's color Renderbuffer Object. It must be bound when SDL_GL_SwapWindow is called. */
272 GLuint resolveFramebuffer; /**< The Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used. */
275 #if defined(SDL_VIDEO_DRIVER_WAYLAND)
278 struct wl_display *display; /**< Wayland display */
279 struct wl_surface *surface; /**< Wayland surface */
280 struct wl_shell_surface *shell_surface; /**< Wayland shell_surface (window manager handle) */
283 #if defined(SDL_VIDEO_DRIVER_MIR) /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
286 void *connection; /**< Mir display server connection */
287 void *surface; /**< Mir surface */
291 #if defined(SDL_VIDEO_DRIVER_ANDROID)
294 ANativeWindow *window;
298 #if defined(SDL_VIDEO_DRIVER_TIZEN)
301 // struct wl_display *display; /**< Wayland display */
302 // struct wl_surface *surface; /**< Wayland surface */
303 // struct wl_shell_surface *shell_surface; /**< Wayland shell_surface (window manager handle) */
306 void* egl_display; /**< EGLDispaly when OPENGLES is enabled */
307 void* egl_surface; /**< EGLSurface when OPENGLES is enabled for this wl_surface */
311 #if defined(SDL_VIDEO_DRIVER_OS2)
314 HWND hwnd; /**< The window handle */
315 HWND hwndFrame; /**< The frame window handle */
319 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
322 EGLNativeDisplayType display;
323 EGLNativeWindowType window;
327 /* Make sure this union is always 64 bytes (8 64-bit pointers). */
328 /* Be careful not to overflow this if you add a new target! */
333 #endif /* SDL_PROTOTYPES_ONLY */
335 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
337 /* Function prototypes */
339 * \brief This function allows access to driver-dependent window information.
341 * \param window The window about which information is being requested
342 * \param info This structure must be initialized with the SDL version, and is
343 * then filled in with information about the given window.
345 * \return SDL_TRUE if the function is implemented and the version member of
346 * the \c info struct is valid, SDL_FALSE otherwise.
348 * You typically use this function like this:
350 * SDL_SysWMinfo info;
351 * SDL_VERSION(&info.version);
352 * if ( SDL_GetWindowWMInfo(window, &info) ) { ... }
355 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
356 SDL_SysWMinfo * info);
359 /* Ends C function definitions when using C++ */
363 #include "close_code.h"
365 #endif /* SDL_syswm_h_ */
367 /* vi: set ts=4 sw=4 expandtab: */