include/SDL_syswm.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 26 Jun 2006 13:56:56 +0000
branchSDL-1.3
changeset 1712 931d111e737a
parent 1668 4da1ee79c9af
permissions -rw-r--r--
Started framework for Windows video driver
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2006 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_NANOX)
   116 #include <microwin/nano-X.h>
   117 
   118 /* The generic custom event structure */
   119 struct SDL_SysWMmsg
   120 {
   121     SDL_version version;
   122     int data;
   123 };
   124 
   125 /* The windows custom window manager information structure */
   126 struct SDL_SysWMinfo
   127 {
   128     SDL_version version;
   129     GR_WINDOW_ID window;        /* The display window */
   130 };
   131 
   132 #elif defined(SDL_VIDEO_DRIVER_WIN32)
   133 #define WIN32_LEAN_AND_MEAN
   134 #include <windows.h>
   135 
   136 /* The windows custom event structure */
   137 struct SDL_SysWMmsg
   138 {
   139     SDL_version version;
   140     HWND hwnd;                  /* The window for the message */
   141     UINT msg;                   /* The type of message */
   142     WPARAM wParam;              /* WORD message parameter */
   143     LPARAM lParam;              /* LONG message parameter */
   144 };
   145 
   146 /* The windows custom window manager information structure */
   147 struct SDL_SysWMinfo
   148 {
   149     SDL_version version;
   150     HWND window;                /* The Win32 display window */
   151     HGLRC hglrc;                /* The OpenGL context, if any */
   152 };
   153 
   154 #elif defined(SDL_VIDEO_DRIVER_RISCOS)
   155 
   156 /* RISC OS custom event structure */
   157 struct SDL_SysWMmsg
   158 {
   159     SDL_version version;
   160     int eventCode;              /* The window for the message */
   161     int pollBlock[64];
   162 };
   163 
   164 /* The RISC OS custom window manager information structure */
   165 struct SDL_SysWMinfo
   166 {
   167     SDL_version version;
   168     int wimpVersion;            /* Wimp version running under */
   169     int taskHandle;             /* The RISC OS task handle */
   170     int window;                 /* The RISC OS display window */
   171 };
   172 
   173 #elif defined(SDL_VIDEO_DRIVER_PHOTON)
   174 #include <sys/neutrino.h>
   175 #include <Ph.h>
   176 
   177 /* The QNX custom event structure */
   178 struct SDL_SysWMmsg
   179 {
   180     SDL_version version;
   181     int data;
   182 };
   183 
   184 /* The QNX custom window manager information structure */
   185 struct SDL_SysWMinfo
   186 {
   187     SDL_version version;
   188     int data;
   189 };
   190 
   191 #else
   192 
   193 /* The generic custom event structure */
   194 struct SDL_SysWMmsg
   195 {
   196     SDL_version version;
   197     int data;
   198 };
   199 
   200 /* The generic custom window manager information structure */
   201 struct SDL_SysWMinfo
   202 {
   203     SDL_version version;
   204     int data;
   205 };
   206 
   207 #endif /* video driver type */
   208 
   209 #endif /* SDL_PROTOTYPES_ONLY */
   210 
   211 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
   212 
   213 /* Function prototypes */
   214 /**
   215  * \fn SDL_bool SDL_GetWindowWMInfo (SDL_WindowID windowID, SDL_SysWMinfo * info)
   216  *
   217  * \brief This function allows access to driver-dependent window information.
   218  *
   219  * \param windowID The window about which information is being requested
   220  * \param info This structure must be initialized with the SDL version, and is then filled in with information about the given window.
   221  *
   222  * \return SDL_TRUE if the function is implemented and the version member of the 'info' struct is valid, SDL_FALSE otherwise.
   223  *
   224  * You typically use this function like this:
   225  * \code
   226  * SDL_SysWMInfo info;
   227  * SDL_VERSION(&info.version);
   228  * if ( SDL_GetWindowWMInfo(&info) ) { ... }
   229  * \endcode
   230  */
   231 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
   232                                                      SDL_SysWMinfo * info);
   233 
   234 
   235 /* Ends C function definitions when using C++ */
   236 #ifdef __cplusplus
   237 /* *INDENT-OFF* */
   238 }
   239 /* *INDENT-ON* */
   240 #endif
   241 #include "close_code.h"
   242 
   243 #endif /* _SDL_syswm_h */
   244 
   245 /* vi: set ts=4 sw=4 expandtab: */