SDL_syswm.h (7917B)
1/* 2 Simple DirectMedia Layer 3 Copyright (C) 1997-2014 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#include "begin_code.h" 37/* Set up for C function definitions, even when using C++ */ 38#ifdef __cplusplus 39extern "C" { 40#endif 41 42/** 43 * \file SDL_syswm.h 44 * 45 * Your application has access to a special type of event ::SDL_SYSWMEVENT, 46 * which contains window-manager specific information and arrives whenever 47 * an unhandled window event occurs. This event is ignored by default, but 48 * you can enable it with SDL_EventState(). 49 */ 50#ifdef SDL_PROTOTYPES_ONLY 51struct SDL_SysWMinfo; 52#else 53 54#if defined(SDL_VIDEO_DRIVER_WINDOWS) 55#ifndef WIN32_LEAN_AND_MEAN 56#define WIN32_LEAN_AND_MEAN 57#endif 58#include <windows.h> 59#endif 60 61#if defined(SDL_VIDEO_DRIVER_WINRT) 62#include <Inspectable.h> 63#endif 64 65/* This is the structure for custom window manager events */ 66#if defined(SDL_VIDEO_DRIVER_X11) 67#if defined(__APPLE__) && defined(__MACH__) 68/* conflicts with Quickdraw.h */ 69#define Cursor X11Cursor 70#endif 71 72#include <X11/Xlib.h> 73#include <X11/Xatom.h> 74 75#if defined(__APPLE__) && defined(__MACH__) 76/* matches the re-define above */ 77#undef Cursor 78#endif 79 80#endif /* defined(SDL_VIDEO_DRIVER_X11) */ 81 82#if defined(SDL_VIDEO_DRIVER_DIRECTFB) 83#include <directfb.h> 84#endif 85 86#if defined(SDL_VIDEO_DRIVER_COCOA) 87#ifdef __OBJC__ 88@class NSWindow; 89#else 90typedef struct _NSWindow NSWindow; 91#endif 92#endif 93 94#if defined(SDL_VIDEO_DRIVER_UIKIT) 95#ifdef __OBJC__ 96#include <UIKit/UIKit.h> 97#else 98typedef struct _UIWindow UIWindow; 99typedef struct _UIViewController UIViewController; 100#endif 101#endif 102 103#if defined(SDL_VIDEO_DRIVER_ANDROID) 104typedef struct ANativeWindow ANativeWindow; 105typedef void *EGLSurface; 106#endif 107 108/** 109 * These are the various supported windowing subsystems 110 */ 111typedef enum 112{ 113 SDL_SYSWM_UNKNOWN, 114 SDL_SYSWM_WINDOWS, 115 SDL_SYSWM_X11, 116 SDL_SYSWM_DIRECTFB, 117 SDL_SYSWM_COCOA, 118 SDL_SYSWM_UIKIT, 119 SDL_SYSWM_WAYLAND, 120 SDL_SYSWM_MIR, 121 SDL_SYSWM_WINRT, 122 SDL_SYSWM_ANDROID 123} SDL_SYSWM_TYPE; 124 125/** 126 * The custom event structure. 127 */ 128struct SDL_SysWMmsg 129{ 130 SDL_version version; 131 SDL_SYSWM_TYPE subsystem; 132 union 133 { 134#if defined(SDL_VIDEO_DRIVER_WINDOWS) 135 struct { 136 HWND hwnd; /**< The window for the message */ 137 UINT msg; /**< The type of message */ 138 WPARAM wParam; /**< WORD message parameter */ 139 LPARAM lParam; /**< LONG message parameter */ 140 } win; 141#endif 142#if defined(SDL_VIDEO_DRIVER_X11) 143 struct { 144 XEvent event; 145 } x11; 146#endif 147#if defined(SDL_VIDEO_DRIVER_DIRECTFB) 148 struct { 149 DFBEvent event; 150 } dfb; 151#endif 152#if defined(SDL_VIDEO_DRIVER_COCOA) 153 struct 154 { 155 /* Latest version of Xcode clang complains about empty structs in C v. C++: 156 error: empty struct has size 0 in C, size 1 in C++ 157 */ 158 int dummy; 159 /* No Cocoa window events yet */ 160 } cocoa; 161#endif 162#if defined(SDL_VIDEO_DRIVER_UIKIT) 163 struct 164 { 165 /* No UIKit window events yet */ 166 } uikit; 167#endif 168 /* Can't have an empty union */ 169 int dummy; 170 } msg; 171}; 172 173/** 174 * The custom window manager information structure. 175 * 176 * When this structure is returned, it holds information about which 177 * low level system it is using, and will be one of SDL_SYSWM_TYPE. 178 */ 179struct SDL_SysWMinfo 180{ 181 SDL_version version; 182 SDL_SYSWM_TYPE subsystem; 183 union 184 { 185#if defined(SDL_VIDEO_DRIVER_WINDOWS) 186 struct 187 { 188 HWND window; /**< The window handle */ 189 } win; 190#endif 191#if defined(SDL_VIDEO_DRIVER_WINRT) 192 struct 193 { 194 IInspectable * window; /**< The WinRT CoreWindow */ 195 } winrt; 196#endif 197#if defined(SDL_VIDEO_DRIVER_X11) 198 struct 199 { 200 Display *display; /**< The X11 display */ 201 Window window; /**< The X11 window */ 202 } x11; 203#endif 204#if defined(SDL_VIDEO_DRIVER_DIRECTFB) 205 struct 206 { 207 IDirectFB *dfb; /**< The directfb main interface */ 208 IDirectFBWindow *window; /**< The directfb window handle */ 209 IDirectFBSurface *surface; /**< The directfb client surface */ 210 } dfb; 211#endif 212#if defined(SDL_VIDEO_DRIVER_COCOA) 213 struct 214 { 215#if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc) 216 NSWindow __unsafe_unretained *window; /* The Cocoa window */ 217#else 218 NSWindow *window; /* The Cocoa window */ 219#endif 220 } cocoa; 221#endif 222#if defined(SDL_VIDEO_DRIVER_UIKIT) 223 struct 224 { 225#if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc) 226 UIWindow __unsafe_unretained *window; /* The UIKit window */ 227#else 228 UIWindow *window; /* The UIKit window */ 229#endif 230 } uikit; 231#endif 232#if defined(SDL_VIDEO_DRIVER_WAYLAND) 233 struct 234 { 235 struct wl_display *display; /**< Wayland display */ 236 struct wl_surface *surface; /**< Wayland surface */ 237 struct wl_shell_surface *shell_surface; /**< Wayland shell_surface (window manager handle) */ 238 } wl; 239#endif 240#if defined(SDL_VIDEO_DRIVER_MIR) 241 struct 242 { 243 struct MirConnection *connection; /**< Mir display server connection */ 244 struct MirSurface *surface; /**< Mir surface */ 245 } mir; 246#endif 247 248#if defined(SDL_VIDEO_DRIVER_ANDROID) 249 struct 250 { 251 ANativeWindow *window; 252 EGLSurface surface; 253 } android; 254#endif 255 256 /* Can't have an empty union */ 257 int dummy; 258 } info; 259}; 260 261#endif /* SDL_PROTOTYPES_ONLY */ 262 263typedef struct SDL_SysWMinfo SDL_SysWMinfo; 264 265/* Function prototypes */ 266/** 267 * \brief This function allows access to driver-dependent window information. 268 * 269 * \param window The window about which information is being requested 270 * \param info This structure must be initialized with the SDL version, and is 271 * then filled in with information about the given window. 272 * 273 * \return SDL_TRUE if the function is implemented and the version member of 274 * the \c info struct is valid, SDL_FALSE otherwise. 275 * 276 * You typically use this function like this: 277 * \code 278 * SDL_SysWMinfo info; 279 * SDL_VERSION(&info.version); 280 * if ( SDL_GetWindowWMInfo(window, &info) ) { ... } 281 * \endcode 282 */ 283extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window, 284 SDL_SysWMinfo * info); 285 286 287/* Ends C function definitions when using C++ */ 288#ifdef __cplusplus 289} 290#endif 291#include "close_code.h" 292 293#endif /* _SDL_syswm_h */ 294 295/* vi: set ts=4 sw=4 expandtab: */