include/SDL_syswm.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 17 May 2006 08:18:28 +0000
branchSDL-1.3
changeset 1659 14717b52abc0
parent 1626 a80e1e0880b8
child 1662 782fd950bd46
child 1895 c121d94672cb
child 3872 be84332e761e
permissions -rw-r--r--
Merge trunk-1.3-3
     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 /* Include file for SDL custom system window manager hooks */
    24 
    25 #ifndef _SDL_syswm_h
    26 #define _SDL_syswm_h
    27 
    28 #include "SDL_stdinc.h"
    29 #include "SDL_error.h"
    30 #include "SDL_version.h"
    31 
    32 #include "begin_code.h"
    33 /* Set up for C function definitions, even when using C++ */
    34 #ifdef __cplusplus
    35 extern "C" {
    36 #endif
    37 
    38 /* Your application has access to a special type of event 'SDL_SYSWMEVENT',
    39    which contains window-manager specific information and arrives whenever
    40    an unhandled window event occurs.  This event is ignored by default, but
    41    you can enable it with SDL_EventState()
    42 */
    43 #ifdef SDL_PROTOTYPES_ONLY
    44 struct SDL_SysWMinfo;
    45 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
    46 #else
    47 
    48 /* This is the structure for custom window manager events */
    49 #if defined(SDL_VIDEO_DRIVER_X11)
    50 #if defined(__APPLE__) && defined(__MACH__)
    51 /* conflicts with Quickdraw.h */
    52 #define Cursor X11Cursor
    53 #endif
    54 
    55 #include <X11/Xlib.h>
    56 #include <X11/Xatom.h>
    57 
    58 #if defined(__APPLE__) && defined(__MACH__)
    59 /* matches the re-define above */
    60 #undef Cursor
    61 #endif
    62 
    63 /* These are the various supported subsystems under UNIX */
    64 typedef enum {
    65 	SDL_SYSWM_X11
    66 } SDL_SYSWM_TYPE;
    67 
    68 /* The UNIX custom event structure */
    69 struct SDL_SysWMmsg {
    70 	SDL_version version;
    71 	SDL_SYSWM_TYPE subsystem;
    72 	union {
    73 	    XEvent xevent;
    74 	} event;
    75 };
    76 
    77 /* The UNIX custom window manager information structure.
    78    When this structure is returned, it holds information about which
    79    low level system it is using, and will be one of SDL_SYSWM_TYPE.
    80  */
    81 typedef struct SDL_SysWMinfo {
    82 	SDL_version version;
    83 	SDL_SYSWM_TYPE subsystem;
    84 	union {
    85 	    struct {
    86 	    	Display *display;	/* The X11 display */
    87 	    	Window window;		/* The X11 display window */
    88 		/* These locking functions should be called around
    89                    any X11 functions using the display variable.
    90                    They lock the event thread, so should not be
    91 		   called around event functions or from event filters.
    92 		 */
    93 		void (*lock_func)(void);
    94 		void (*unlock_func)(void);
    95 
    96 		/* Introduced in SDL 1.0.2 */
    97 	    	Window fswindow;	/* The X11 fullscreen window */
    98 	    	Window wmwindow;	/* The X11 managed input window */
    99 	    } x11;
   100 	} info;
   101 } SDL_SysWMinfo;
   102 
   103 #elif defined(SDL_VIDEO_DRIVER_NANOX)
   104 #include <microwin/nano-X.h>
   105 
   106 /* The generic custom event structure */
   107 struct SDL_SysWMmsg {
   108 	SDL_version version;
   109 	int data;
   110 };
   111 
   112 /* The windows custom window manager information structure */
   113 typedef struct SDL_SysWMinfo {
   114 	SDL_version version ;
   115 	GR_WINDOW_ID window ;	/* The display window */
   116 } SDL_SysWMinfo;
   117 
   118 #elif defined(SDL_VIDEO_DRIVER_WINDIB) || defined(SDL_VIDEO_DRIVER_DDRAW) || defined(SDL_VIDEO_DRIVER_GAPI)
   119 #define WIN32_LEAN_AND_MEAN
   120 #include <windows.h>
   121 
   122 /* The windows custom event structure */
   123 struct SDL_SysWMmsg {
   124 	SDL_version version;
   125 	HWND hwnd;			/* The window for the message */
   126 	UINT msg;			/* The type of message */
   127 	WPARAM wParam;			/* WORD message parameter */
   128 	LPARAM lParam;			/* LONG message parameter */
   129 };
   130 
   131 /* The windows custom window manager information structure */
   132 typedef struct SDL_SysWMinfo {
   133 	SDL_version version;
   134 	HWND window;			/* The Win32 display window */
   135 	HGLRC hglrc;			/* The OpenGL context, if any */
   136 } SDL_SysWMinfo;
   137 
   138 #elif defined(SDL_VIDEO_DRIVER_RISCOS)
   139 
   140 /* RISC OS custom event structure */
   141 struct SDL_SysWMmsg {
   142 	SDL_version version;
   143 	int eventCode;		/* The window for the message */
   144 	int pollBlock[64];
   145 };
   146 
   147 /* The RISC OS custom window manager information structure */
   148 typedef struct SDL_SysWMinfo {
   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 } SDL_SysWMinfo;
   154 
   155 #elif defined(SDL_VIDEO_DRIVER_PHOTON)
   156 #include <sys/neutrino.h>
   157 #include <Ph.h>
   158 
   159 /* The QNX custom event structure */
   160 struct SDL_SysWMmsg {
   161 	SDL_version version;
   162 	int data;
   163 };
   164 
   165 /* The QNX custom window manager information structure */
   166 typedef struct SDL_SysWMinfo {
   167 	SDL_version version;
   168 	int data;
   169 } SDL_SysWMinfo;
   170 
   171 #else
   172 
   173 /* The generic custom event structure */
   174 struct SDL_SysWMmsg {
   175 	SDL_version version;
   176 	int data;
   177 };
   178 
   179 /* The generic custom window manager information structure */
   180 typedef struct SDL_SysWMinfo {
   181 	SDL_version version;
   182 	int data;
   183 } SDL_SysWMinfo;
   184 
   185 #endif /* video driver type */
   186 
   187 #endif /* SDL_PROTOTYPES_ONLY */
   188 
   189 /* Function prototypes */
   190 /*
   191  * This function gives you custom hooks into the window manager information.
   192  * It fills the structure pointed to by 'info' with custom information and
   193  * returns 1 if the function is implemented.  If it's not implemented, or
   194  * the version member of the 'info' structure is invalid, it returns 0. 
   195  *
   196  * You typically use this function like this:
   197  * SDL_SysWMInfo info;
   198  * SDL_VERSION(&info.version);
   199  * if ( SDL_GetWMInfo(&info) ) { ... }
   200  */
   201 extern DECLSPEC int SDLCALL SDL_GetWMInfo(SDL_SysWMinfo *info);
   202 
   203 
   204 /* Ends C function definitions when using C++ */
   205 #ifdef __cplusplus
   206 }
   207 #endif
   208 #include "close_code.h"
   209 
   210 #endif /* _SDL_syswm_h */