include/SDL_syswm.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 02 Feb 2014 00:53:27 -0800
changeset 8149 681eb46b8ac4
parent 8134 7c9192be51a7
child 8153 3e43c73ac79b
permissions -rw-r--r--
Fixed bug 2374 - Update copyright for 2014...

Is it that time already??
     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_TYPE;
   109 
   110 /**
   111  *  The custom event structure.
   112  */
   113 struct SDL_SysWMmsg
   114 {
   115     SDL_version version;
   116     SDL_SYSWM_TYPE subsystem;
   117     union
   118     {
   119 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
   120         struct {
   121             HWND hwnd;                  /**< The window for the message */
   122             UINT msg;                   /**< The type of message */
   123             WPARAM wParam;              /**< WORD message parameter */
   124             LPARAM lParam;              /**< LONG message parameter */
   125         } win;
   126 #endif
   127 #if defined(SDL_VIDEO_DRIVER_X11)
   128         struct {
   129             XEvent event;
   130         } x11;
   131 #endif
   132 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
   133         struct {
   134             DFBEvent event;
   135         } dfb;
   136 #endif
   137 #if defined(SDL_VIDEO_DRIVER_COCOA)
   138         struct
   139         {
   140             /* No Cocoa window events yet */
   141         } cocoa;
   142 #endif
   143 #if defined(SDL_VIDEO_DRIVER_UIKIT)
   144         struct
   145         {
   146             /* No UIKit window events yet */
   147         } uikit;
   148 #endif
   149         /* Can't have an empty union */
   150         int dummy;
   151     } msg;
   152 };
   153 
   154 /**
   155  *  The custom window manager information structure.
   156  *
   157  *  When this structure is returned, it holds information about which
   158  *  low level system it is using, and will be one of SDL_SYSWM_TYPE.
   159  */
   160 struct SDL_SysWMinfo
   161 {
   162     SDL_version version;
   163     SDL_SYSWM_TYPE subsystem;
   164     union
   165     {
   166 #if defined(SDL_VIDEO_DRIVER_WINDOWS)
   167         struct
   168         {
   169             HWND window;                /**< The window handle */
   170         } win;
   171 #endif
   172 #if defined(SDL_VIDEO_DRIVER_X11)
   173         struct
   174         {
   175             Display *display;           /**< The X11 display */
   176             Window window;              /**< The X11 window */
   177         } x11;
   178 #endif
   179 #if defined(SDL_VIDEO_DRIVER_DIRECTFB)
   180         struct
   181         {
   182             IDirectFB *dfb;             /**< The directfb main interface */
   183             IDirectFBWindow *window;    /**< The directfb window handle */
   184             IDirectFBSurface *surface;  /**< The directfb client surface */
   185         } dfb;
   186 #endif
   187 #if defined(SDL_VIDEO_DRIVER_COCOA)
   188         struct
   189         {
   190             NSWindow *window;           /* The Cocoa window */
   191         } cocoa;
   192 #endif
   193 #if defined(SDL_VIDEO_DRIVER_UIKIT)
   194         struct
   195         {
   196             UIWindow *window;           /* The UIKit window */
   197         } uikit;
   198 #endif
   199 #if defined(SDL_VIDEO_DRIVER_WAYLAND)
   200         struct
   201         {
   202             struct wl_display *display;            /**< Wayland display */
   203             struct wl_surface *surface;            /**< Wayland surface */
   204             struct wl_shell_surface *shell_surface; /**< Wayland shell_surface (window manager handle) */
   205         } wl;
   206 #endif
   207         /* Can't have an empty union */
   208         int dummy;
   209     } info;
   210 };
   211 
   212 #endif /* SDL_PROTOTYPES_ONLY */
   213 
   214 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
   215 
   216 /* Function prototypes */
   217 /**
   218  *  \brief This function allows access to driver-dependent window information.
   219  *
   220  *  \param window The window about which information is being requested
   221  *  \param info This structure must be initialized with the SDL version, and is
   222  *              then filled in with information about the given window.
   223  *
   224  *  \return SDL_TRUE if the function is implemented and the version member of
   225  *          the \c info struct is valid, SDL_FALSE otherwise.
   226  *
   227  *  You typically use this function like this:
   228  *  \code
   229  *  SDL_SysWMinfo info;
   230  *  SDL_VERSION(&info.version);
   231  *  if ( SDL_GetWindowWMInfo(window, &info) ) { ... }
   232  *  \endcode
   233  */
   234 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_Window * window,
   235                                                      SDL_SysWMinfo * info);
   236 
   237 
   238 /* Ends C function definitions when using C++ */
   239 #ifdef __cplusplus
   240 }
   241 #endif
   242 #include "close_code.h"
   243 
   244 #endif /* _SDL_syswm_h */
   245 
   246 /* vi: set ts=4 sw=4 expandtab: */