include/SDL_syswm.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 02 Feb 2014 23:41:46 -0500
changeset 8153 3e43c73ac79b
parent 8149 681eb46b8ac4
child 8155 cf0eda3f5e35
permissions -rw-r--r--
Added Mir video target (thanks, Brandon!).
     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
    39 extern "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
    51 struct SDL_SysWMinfo;
    52 #else
    53 
    54 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
    55 #define WIN32_LEAN_AND_MEAN
    56 #include <windows.h>
    57 #endif
    58 
    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
    64 #endif
    65 
    66 #include <X11/Xlib.h>
    67 #include <X11/Xatom.h>
    68 
    69 #if defined(__APPLE__) && defined(__MACH__)
    70 /* matches the re-define above */
    71 #undef Cursor
    72 #endif
    73 
    74 #endif /* defined(SDL_VIDEO_DRIVER_X11) */
    75 
    76 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
    77 #include <directfb.h>
    78 #endif
    79 
    80 #if defined(SDL_VIDEO_DRIVER_COCOA)
    81 #ifdef __OBJC__
    82 #include <Cocoa/Cocoa.h>
    83 #else
    84 typedef struct _NSWindow NSWindow;
    85 #endif
    86 #endif
    87 
    88 #if defined(SDL_VIDEO_DRIVER_UIKIT)
    89 #ifdef __OBJC__
    90 #include <UIKit/UIKit.h>
    91 #else
    92 typedef struct _UIWindow UIWindow;
    93 #endif
    94 #endif
    95 
    96 /**
    97  *  These are the various supported windowing subsystems
    98  */
    99 typedef enum
   100 {
   101     SDL_SYSWM_UNKNOWN,
   102     SDL_SYSWM_WINDOWS,
   103     SDL_SYSWM_X11,
   104     SDL_SYSWM_DIRECTFB,
   105     SDL_SYSWM_COCOA,
   106     SDL_SYSWM_UIKIT,
   107     SDL_SYSWM_WAYLAND,
   108     SDL_SYSWM_MIR,
   109 } SDL_SYSWM_TYPE;
   110 
   111 /**
   112  *  The custom event structure.
   113  */
   114 struct SDL_SysWMmsg
   115 {
   116     SDL_version version;
   117     SDL_SYSWM_TYPE subsystem;
   118     union
   119     {
   120 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
   121         struct {
   122             HWND hwnd;                  /**< The window for the message */
   123             UINT msg;                   /**< The type of message */
   124             WPARAM wParam;              /**< WORD message parameter */
   125             LPARAM lParam;              /**< LONG message parameter */
   126         } win;
   127 #endif
   128 #if defined(SDL_VIDEO_DRIVER_X11)
   129         struct {
   130             XEvent event;
   131         } x11;
   132 #endif
   133 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
   134         struct {
   135             DFBEvent event;
   136         } dfb;
   137 #endif
   138 #if defined(SDL_VIDEO_DRIVER_COCOA)
   139         struct
   140         {
   141             /* No Cocoa window events yet */
   142         } cocoa;
   143 #endif
   144 #if defined(SDL_VIDEO_DRIVER_UIKIT)
   145         struct
   146         {
   147             /* No UIKit window events yet */
   148         } uikit;
   149 #endif
   150         /* Can't have an empty union */
   151         int dummy;
   152     } msg;
   153 };
   154 
   155 /**
   156  *  The custom window manager information structure.
   157  *
   158  *  When this structure is returned, it holds information about which
   159  *  low level system it is using, and will be one of SDL_SYSWM_TYPE.
   160  */
   161 struct SDL_SysWMinfo
   162 {
   163     SDL_version version;
   164     SDL_SYSWM_TYPE subsystem;
   165     union
   166     {
   167 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
   168         struct
   169         {
   170             HWND window;                /**< The window handle */
   171         } win;
   172 #endif
   173 #if defined(SDL_VIDEO_DRIVER_X11)
   174         struct
   175         {
   176             Display *display;           /**< The X11 display */
   177             Window window;              /**< The X11 window */
   178         } x11;
   179 #endif
   180 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
   181         struct
   182         {
   183             IDirectFB *dfb;             /**< The directfb main interface */
   184             IDirectFBWindow *window;    /**< The directfb window handle */
   185             IDirectFBSurface *surface;  /**< The directfb client surface */
   186         } dfb;
   187 #endif
   188 #if defined(SDL_VIDEO_DRIVER_COCOA)
   189         struct
   190         {
   191             NSWindow *window;           /* The Cocoa window */
   192         } cocoa;
   193 #endif
   194 #if defined(SDL_VIDEO_DRIVER_UIKIT)
   195         struct
   196         {
   197             UIWindow *window;           /* The UIKit window */
   198         } uikit;
   199 #endif
   200 #if defined(SDL_VIDEO_DRIVER_WAYLAND)
   201         struct
   202         {
   203             struct wl_display *display;            /**< Wayland display */
   204             struct wl_surface *surface;            /**< Wayland surface */
   205             struct wl_shell_surface *shell_surface; /**< Wayland shell_surface (window manager handle) */
   206         } wl;
   207 #endif
   208         /* Can't have an empty union */
   209         int dummy;
   210     } info;
   211 };
   212 
   213 #endif /* SDL_PROTOTYPES_ONLY */
   214 
   215 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
   216 
   217 /* Function prototypes */
   218 /**
   219  *  \brief This function allows access to driver-dependent window information.
   220  *
   221  *  \param window The window about which information is being requested
   222  *  \param info This structure must be initialized with the SDL version, and is
   223  *              then filled in with information about the given window.
   224  *
   225  *  \return SDL_TRUE if the function is implemented and the version member of
   226  *          the \c info struct is valid, SDL_FALSE otherwise.
   227  *
   228  *  You typically use this function like this:
   229  *  \code
   230  *  SDL_SysWMinfo info;
   231  *  SDL_VERSION(&info.version);
   232  *  if ( SDL_GetWindowWMInfo(window, &info) ) { ... }
   233  *  \endcode
   234  */
   235 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
   236                                                      SDL_SysWMinfo * info);
   237 
   238 
   239 /* Ends C function definitions when using C++ */
   240 #ifdef __cplusplus
   241 }
   242 #endif
   243 #include "close_code.h"
   244 
   245 #endif /* _SDL_syswm_h */
   246 
   247 /* vi: set ts=4 sw=4 expandtab: */