2 Simple DirectMedia Layer
3 Copyright (C) 1997-2019 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
55 #if defined(SDL_VIDEO_DRIVER_WINRT)
56 #include <Inspectable.h>
59 /* This is the structure for custom window manager events */
60 #if defined(SDL_VIDEO_DRIVER_X11)
61 #if defined(__APPLE__) && defined(__MACH__)
62 /* conflicts with Quickdraw.h */
63 #define Cursor X11Cursor
67 #include <X11/Xatom.h>
69 #if defined(__APPLE__) && defined(__MACH__)
70 /* matches the re-define above */
74 #endif /* defined(SDL_VIDEO_DRIVER_X11) */
76 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
80 #if defined(SDL_VIDEO_DRIVER_COCOA)
84 typedef struct _NSWindow NSWindow;
88 #if defined(SDL_VIDEO_DRIVER_UIKIT)
90 #include <UIKit/UIKit.h>
92 typedef struct _UIWindow UIWindow;
93 typedef struct _UIViewController UIViewController;
95 typedef Uint32 GLuint;
98 #if defined(SDL_VIDEO_DRIVER_ANDROID)
99 typedef struct ANativeWindow ANativeWindow;
100 typedef void *EGLSurface;
103 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
106 #endif /* SDL_PROTOTYPES_ONLY */
109 #include "begin_code.h"
110 /* Set up for C function definitions, even when using C++ */
115 #if !defined(SDL_PROTOTYPES_ONLY)
117 * These are the various supported windowing subsystems
128 SDL_SYSWM_MIR, /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
136 * The custom event structure.
141 SDL_SYSWM_TYPE subsystem;
144 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
146 HWND hwnd; /**< The window for the message */
147 UINT msg; /**< The type of message */
148 WPARAM wParam; /**< WORD message parameter */
149 LPARAM lParam; /**< LONG message parameter */
152 #if defined(SDL_VIDEO_DRIVER_X11)
157 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
162 #if defined(SDL_VIDEO_DRIVER_COCOA)
165 /* Latest version of Xcode clang complains about empty structs in C v. C++:
166 error: empty struct has size 0 in C, size 1 in C++
169 /* No Cocoa window events yet */
172 #if defined(SDL_VIDEO_DRIVER_UIKIT)
176 /* No UIKit window events yet */
179 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
183 /* No Vivante window events yet */
186 /* Can't have an empty union */
192 * The custom window manager information structure.
194 * When this structure is returned, it holds information about which
195 * low level system it is using, and will be one of SDL_SYSWM_TYPE.
200 SDL_SYSWM_TYPE subsystem;
203 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
206 HWND window; /**< The window handle */
207 HDC hdc; /**< The window device context */
208 HINSTANCE hinstance; /**< The instance handle */
211 #if defined(SDL_VIDEO_DRIVER_WINRT)
214 IInspectable * window; /**< The WinRT CoreWindow */
217 #if defined(SDL_VIDEO_DRIVER_X11)
220 Display *display; /**< The X11 display */
221 Window window; /**< The X11 window */
224 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
227 IDirectFB *dfb; /**< The directfb main interface */
228 IDirectFBWindow *window; /**< The directfb window handle */
229 IDirectFBSurface *surface; /**< The directfb client surface */
232 #if defined(SDL_VIDEO_DRIVER_COCOA)
235 #if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
236 NSWindow __unsafe_unretained *window; /**< The Cocoa window */
238 NSWindow *window; /**< The Cocoa window */
242 #if defined(SDL_VIDEO_DRIVER_UIKIT)
245 #if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
246 UIWindow __unsafe_unretained *window; /**< The UIKit window */
248 UIWindow *window; /**< The UIKit window */
250 GLuint framebuffer; /**< The GL view's Framebuffer Object. It must be bound when rendering to the screen using GL. */
251 GLuint colorbuffer; /**< The GL view's color Renderbuffer Object. It must be bound when SDL_GL_SwapWindow is called. */
252 GLuint resolveFramebuffer; /**< The Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used. */
255 #if defined(SDL_VIDEO_DRIVER_WAYLAND)
258 struct wl_display *display; /**< Wayland display */
259 struct wl_surface *surface; /**< Wayland surface */
260 struct wl_shell_surface *shell_surface; /**< Wayland shell_surface (window manager handle) */
263 #if defined(SDL_VIDEO_DRIVER_MIR) /* no longer available, left for API/ABI compatibility. Remove in 2.1! */
266 void *connection; /**< Mir display server connection */
267 void *surface; /**< Mir surface */
271 #if defined(SDL_VIDEO_DRIVER_ANDROID)
274 ANativeWindow *window;
279 #if defined(SDL_VIDEO_DRIVER_VIVANTE)
282 EGLNativeDisplayType display;
283 EGLNativeWindowType window;
287 /* Make sure this union is always 64 bytes (8 64-bit pointers). */
288 /* Be careful not to overflow this if you add a new target! */
293 #endif /* SDL_PROTOTYPES_ONLY */
295 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
297 /* Function prototypes */
299 * \brief This function allows access to driver-dependent window information.
301 * \param window The window about which information is being requested
302 * \param info This structure must be initialized with the SDL version, and is
303 * then filled in with information about the given window.
305 * \return SDL_TRUE if the function is implemented and the version member of
306 * the \c info struct is valid, SDL_FALSE otherwise.
308 * You typically use this function like this:
310 * SDL_SysWMinfo info;
311 * SDL_VERSION(&info.version);
312 * if ( SDL_GetWindowWMInfo(window, &info) ) { ... }
315 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
316 SDL_SysWMinfo * info);
319 /* Ends C function definitions when using C++ */
323 #include "close_code.h"
325 #endif /* SDL_syswm_h_ */
327 /* vi: set ts=4 sw=4 expandtab: */