include/SDL_syswm.h
author David Ludwig <dludwig@pobox.com>
Tue, 27 Aug 2013 11:44:43 -0400
changeset 8496 9f0a4fbc6452
parent 8477 ad08f0d710f3
child 8500 f25ef28d61e8
permissions -rw-r--r--
WinRT: renamed SDL_SYSWM_WINDOWSRT to SDL_SYSWM_WINRT
This is part of an overall effort to use the name, "WinRT", rather than "WindowsRT" (or "Windows RT"), as the shorthand name often seems to mean something different than the longhand name. (WinRT is an API, Windows RT is a product name)
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 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 #if defined(SDL_VIDEO_DRIVER_WINRT)
    60 #include <Unknwn.h>
    61 #endif
    62 
    63 /* This is the structure for custom window manager events */
    64 #if defined(SDL_VIDEO_DRIVER_X11)
    65 #if defined(__APPLE__) && defined(__MACH__)
    66 /* conflicts with Quickdraw.h */
    67 #define Cursor X11Cursor
    68 #endif
    69 
    70 #include <X11/Xlib.h>
    71 #include <X11/Xatom.h>
    72 
    73 #if defined(__APPLE__) && defined(__MACH__)
    74 /* matches the re-define above */
    75 #undef Cursor
    76 #endif
    77 
    78 #endif /* defined(SDL_VIDEO_DRIVER_X11) */
    79 
    80 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
    81 #include <directfb.h>
    82 #endif
    83 
    84 #if defined(SDL_VIDEO_DRIVER_COCOA)
    85 #ifdef __OBJC__
    86 #include <Cocoa/Cocoa.h>
    87 #else
    88 typedef struct _NSWindow NSWindow;
    89 #endif
    90 #endif
    91 
    92 #if defined(SDL_VIDEO_DRIVER_UIKIT)
    93 #ifdef __OBJC__
    94 #include <UIKit/UIKit.h>
    95 #else
    96 typedef struct _UIWindow UIWindow;
    97 typedef struct _UIViewController UIViewController;
    98 #endif
    99 #endif
   100 
   101 /**
   102  *  These are the various supported windowing subsystems
   103  */
   104 typedef enum
   105 {
   106     SDL_SYSWM_UNKNOWN,
   107     SDL_SYSWM_WINDOWS,
   108     SDL_SYSWM_WINRT,
   109     SDL_SYSWM_X11,
   110     SDL_SYSWM_DIRECTFB,
   111     SDL_SYSWM_COCOA,
   112     SDL_SYSWM_UIKIT,
   113 } SDL_SYSWM_TYPE;
   114 
   115 /**
   116  *  The custom event structure.
   117  */
   118 struct SDL_SysWMmsg
   119 {
   120     SDL_version version;
   121     SDL_SYSWM_TYPE subsystem;
   122     union
   123     {
   124 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
   125         struct {
   126             HWND hwnd;                  /**< The window for the message */
   127             UINT msg;                   /**< The type of message */
   128             WPARAM wParam;              /**< WORD message parameter */
   129             LPARAM lParam;              /**< LONG message parameter */
   130         } win;
   131 #endif
   132 #if defined(SDL_VIDEO_DRIVER_X11)
   133         struct {
   134             XEvent event;
   135         } x11;
   136 #endif
   137 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
   138         struct {
   139             DFBEvent event;
   140         } dfb;
   141 #endif
   142 #if defined(SDL_VIDEO_DRIVER_COCOA)
   143         struct
   144         {
   145             /* No Cocoa window events yet */
   146         } cocoa;
   147 #endif
   148 #if defined(SDL_VIDEO_DRIVER_UIKIT)
   149         struct
   150         {
   151             /* No UIKit window events yet */
   152         } uikit;
   153 #endif
   154         /* Can't have an empty union */
   155         int dummy;
   156     } msg;
   157 };
   158 
   159 /**
   160  *  The custom window manager information structure.
   161  *
   162  *  When this structure is returned, it holds information about which
   163  *  low level system it is using, and will be one of SDL_SYSWM_TYPE.
   164  */
   165 struct SDL_SysWMinfo
   166 {
   167     SDL_version version;
   168     SDL_SYSWM_TYPE subsystem;
   169     union
   170     {
   171 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
   172         struct
   173         {
   174             HWND window;                /**< The window handle */
   175         } win;
   176 #endif
   177 #if defined(SDL_VIDEO_DRIVER_WINRT)
   178         struct
   179         {
   180             IUnknown * window;          /**< The Windows RT CoreWindow */
   181         } winrt;
   182 #endif
   183 #if defined(SDL_VIDEO_DRIVER_X11)
   184         struct
   185         {
   186             Display *display;           /**< The X11 display */
   187             Window window;              /**< The X11 window */
   188         } x11;
   189 #endif
   190 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
   191         struct
   192         {
   193             IDirectFB *dfb;             /**< The directfb main interface */
   194             IDirectFBWindow *window;    /**< The directfb window handle */
   195             IDirectFBSurface *surface;  /**< The directfb client surface */
   196         } dfb;
   197 #endif
   198 #if defined(SDL_VIDEO_DRIVER_COCOA)
   199         struct
   200         {
   201             NSWindow *window;           /* The Cocoa window */
   202         } cocoa;
   203 #endif
   204 #if defined(SDL_VIDEO_DRIVER_UIKIT)
   205         struct
   206         {
   207             UIWindow *window;           /* The UIKit window */
   208             UIViewController *viewcontroller;   /* The UIKit view controller */
   209         } uikit;
   210 #endif
   211         /* Can't have an empty union */
   212         int dummy;
   213     } info;
   214 };
   215 
   216 #endif /* SDL_PROTOTYPES_ONLY */
   217 
   218 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
   219 
   220 /* Function prototypes */
   221 /**
   222  *  \brief This function allows access to driver-dependent window information.
   223  *
   224  *  \param window The window about which information is being requested
   225  *  \param info This structure must be initialized with the SDL version, and is
   226  *              then filled in with information about the given window.
   227  *
   228  *  \return SDL_TRUE if the function is implemented and the version member of
   229  *          the \c info struct is valid, SDL_FALSE otherwise.
   230  *
   231  *  You typically use this function like this:
   232  *  \code
   233  *  SDL_SysWMinfo info;
   234  *  SDL_VERSION(&info.version);
   235  *  if ( SDL_GetWindowWMInfo(window, &info) ) { ... }
   236  *  \endcode
   237  */
   238 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
   239                                                      SDL_SysWMinfo * info);
   240 
   241 
   242 /* Ends C function definitions when using C++ */
   243 #ifdef __cplusplus
   244 }
   245 #endif
   246 #include "close_code.h"
   247 
   248 #endif /* _SDL_syswm_h */
   249 
   250 /* vi: set ts=4 sw=4 expandtab: */