include/SDL_syswm.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 19 Sep 2009 07:26:51 +0000
changeset 3274 08574b033f37
parent 3114 979164e58723
child 3407 d3baf5ac4e37
permissions -rw-r--r--
Removed outdated Nano-X support
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2009 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /**
    24  * \file SDL_syswm.h
    25  *
    26  * Include file for SDL custom system window manager hooks
    27  */
    28 
    29 #ifndef _SDL_syswm_h
    30 #define _SDL_syswm_h
    31 
    32 #include "SDL_stdinc.h"
    33 #include "SDL_error.h"
    34 #include "SDL_video.h"
    35 #include "SDL_version.h"
    36 
    37 #include "begin_code.h"
    38 /* Set up for C function definitions, even when using C++ */
    39 #ifdef __cplusplus
    40 /* *INDENT-OFF* */
    41 extern "C" {
    42 /* *INDENT-ON* */
    43 #endif
    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 /* This is the structure for custom window manager events */
    55 #if defined(SDL_VIDEO_DRIVER_X11)
    56 #if defined(__APPLE__) && defined(__MACH__)
    57 /* conflicts with Quickdraw.h */
    58 #define Cursor X11Cursor
    59 #endif
    60 
    61 #include <X11/Xlib.h>
    62 #include <X11/Xatom.h>
    63 
    64 #if defined(__APPLE__) && defined(__MACH__)
    65 /* matches the re-define above */
    66 #undef Cursor
    67 #endif
    68 
    69 /* These are the various supported subsystems under UNIX */
    70 typedef enum
    71 {
    72     SDL_SYSWM_X11
    73 } SDL_SYSWM_TYPE;
    74 
    75 /* The UNIX custom event structure */
    76 struct SDL_SysWMmsg
    77 {
    78     SDL_version version;
    79     SDL_SYSWM_TYPE subsystem;
    80     union
    81     {
    82         XEvent xevent;
    83     } event;
    84 };
    85 
    86 /* The UNIX custom window manager information structure.
    87    When this structure is returned, it holds information about which
    88    low level system it is using, and will be one of SDL_SYSWM_TYPE.
    89  */
    90 struct SDL_SysWMinfo
    91 {
    92     SDL_version version;
    93     SDL_SYSWM_TYPE subsystem;
    94     union
    95     {
    96         struct
    97         {
    98             Display *display;   /* The X11 display */
    99             Window window;      /* The X11 display window */
   100             /* These locking functions should be called around
   101                any X11 functions using the display variable.
   102                They lock the event thread, so should not be
   103                called around event functions or from event filters.
   104              */
   105             void (*lock_func) (void);
   106             void (*unlock_func) (void);
   107 
   108             /* Introduced in SDL 1.0.2 */
   109             Window fswindow;    /* The X11 fullscreen window */
   110             Window wmwindow;    /* The X11 managed input window */
   111         } x11;
   112     } info;
   113 };
   114 
   115 #elif defined(SDL_VIDEO_DRIVER_WIN32)
   116 #define WIN32_LEAN_AND_MEAN
   117 #include <windows.h>
   118 
   119 /* The windows custom event structure */
   120 struct SDL_SysWMmsg
   121 {
   122     SDL_version version;
   123     HWND hwnd;                  /* The window for the message */
   124     UINT msg;                   /* The type of message */
   125     WPARAM wParam;              /* WORD message parameter */
   126     LPARAM lParam;              /* LONG message parameter */
   127 };
   128 
   129 /* The windows custom window manager information structure */
   130 struct SDL_SysWMinfo
   131 {
   132     SDL_version version;
   133     HWND window;                /* The Win32 display window */
   134 };
   135 
   136 #elif defined(SDL_VIDEO_DRIVER_RISCOS)
   137 
   138 /* RISC OS custom event structure */
   139 struct SDL_SysWMmsg
   140 {
   141     SDL_version version;
   142     int eventCode;              /* The window for the message */
   143     int pollBlock[64];
   144 };
   145 
   146 /* The RISC OS custom window manager information structure */
   147 struct SDL_SysWMinfo
   148 {
   149     SDL_version version;
   150     int wimpVersion;            /* Wimp version running under */
   151     int taskHandle;             /* The RISC OS task handle */
   152     int window;                 /* The RISC OS display window */
   153 };
   154 
   155 #elif defined(SDL_VIDEO_DRIVER_PHOTON) || defined(SDL_VIDEO_DRIVER_QNXGF)
   156 #include <sys/neutrino.h>
   157 #if defined(SDL_VIDEO_OPENGL_ES)
   158 #include <gf/gf.h>
   159 #endif /* SDL_VIDEO_OPENGL_ES */
   160 #include <Ph.h>
   161 
   162 /* The QNX custom event structure */
   163 struct SDL_SysWMmsg
   164 {
   165     SDL_version version;
   166     int data;
   167 };
   168 
   169 /* The QNX Photon custom window manager information structure */
   170 struct SDL_SysWMinfo
   171 {
   172     SDL_version version;
   173     int data;
   174 };
   175 
   176 #else
   177 
   178 /* The generic custom event structure */
   179 struct SDL_SysWMmsg
   180 {
   181     SDL_version version;
   182     int data;
   183 };
   184 
   185 /* The generic custom window manager information structure */
   186 struct SDL_SysWMinfo
   187 {
   188     SDL_version version;
   189     int data;
   190 };
   191 
   192 #endif /* video driver type */
   193 
   194 #endif /* SDL_PROTOTYPES_ONLY */
   195 
   196 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
   197 
   198 /* Function prototypes */
   199 /**
   200  * \fn SDL_bool SDL_GetWindowWMInfo (SDL_WindowID windowID, SDL_SysWMinfo * info)
   201  *
   202  * \brief This function allows access to driver-dependent window information.
   203  *
   204  * \param windowID The window about which information is being requested
   205  * \param info This structure must be initialized with the SDL version, and is then filled in with information about the given window.
   206  *
   207  * \return SDL_TRUE if the function is implemented and the version member of the 'info' struct is valid, SDL_FALSE otherwise.
   208  *
   209  * You typically use this function like this:
   210  * \code
   211  * SDL_SysWMInfo info;
   212  * SDL_VERSION(&info.version);
   213  * if ( SDL_GetWindowWMInfo(&info) ) { ... }
   214  * \endcode
   215  */
   216 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
   217                                                      SDL_SysWMinfo * info);
   218 
   219 
   220 /* Ends C function definitions when using C++ */
   221 #ifdef __cplusplus
   222 /* *INDENT-OFF* */
   223 }
   224 /* *INDENT-ON* */
   225 #endif
   226 #include "close_code.h"
   227 
   228 #endif /* _SDL_syswm_h */
   229 
   230 /* vi: set ts=4 sw=4 expandtab: */