comparison include/SDL_syswm.h @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 57bf11a5efd7
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 /*
2 SDL - Simple DirectMedia Layer
3 Copyright (C) 1997, 1998, 1999, 2000, 2001 Sam Lantinga
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 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 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with this library; if not, write to the Free
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19 Sam Lantinga
20 slouken@devolution.com
21 */
22
23 #ifdef SAVE_RCSID
24 static char rcsid =
25 "@(#) $Id$";
26 #endif
27
28 /* Include file for SDL custom system window manager hooks */
29
30 #ifndef _SDL_syswm_h
31 #define _SDL_syswm_h
32
33 #include "SDL_version.h"
34
35 #include "begin_code.h"
36 /* Set up for C function definitions, even when using C++ */
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /* Your application has access to a special type of event 'SDL_SYSWMEVENT',
42 which contains window-manager specific information and arrives whenever
43 an unhandled window event occurs. This event is ignored by default, but
44 you can enable it with SDL_EventState()
45 */
46 #ifdef SDL_PROTOTYPES_ONLY
47 struct SDL_SysWMinfo;
48 typedef struct SDL_SysWMinfo SDL_SysWMinfo;
49 #else
50
51 /* This is the structure for custom window manager events */
52 #if (defined(unix) || defined(__unix__) || defined(_AIX)) && \
53 (!defined(DISABLE_X11) && !defined(__CYGWIN32__))
54 /* AIX is unix, of course, but the native compiler CSet doesn't define unix */
55 #include <X11/Xlib.h>
56 #include <X11/Xatom.h>
57
58 /* These are the various supported subsystems under UNIX */
59 typedef enum {
60 SDL_SYSWM_X11
61 } SDL_SYSWM_TYPE;
62
63 /* The UNIX custom event structure */
64 struct SDL_SysWMmsg {
65 SDL_version version;
66 SDL_SYSWM_TYPE subsystem;
67 union {
68 XEvent xevent;
69 } event;
70 };
71
72 /* The UNIX custom window manager information structure.
73 When this structure is returned, it holds information about which
74 low level system it is using, and will be one of SDL_SYSWM_TYPE.
75 */
76 typedef struct {
77 SDL_version version;
78 SDL_SYSWM_TYPE subsystem;
79 union {
80 struct {
81 Display *display; /* The X11 display */
82 Window window; /* The X11 display window */
83 /* These locking functions should be called around
84 any X11 functions using the display variable.
85 They lock the event thread, so should not be
86 called around event functions or from event filters.
87 */
88 void (*lock_func)(void);
89 void (*unlock_func)(void);
90
91 /* Introduced in SDL 1.0.2 */
92 Window fswindow; /* The X11 fullscreen window */
93 Window wmwindow; /* The X11 managed input window */
94 } x11;
95 } info;
96 } SDL_SysWMinfo;
97
98 #elif defined(WIN32)
99 #include <windows.h>
100
101 /* The windows custom event structure */
102 struct SDL_SysWMmsg {
103 SDL_version version;
104 HWND hwnd; /* The window for the message */
105 UINT msg; /* The type of message */
106 WPARAM wParam; /* WORD message parameter */
107 LPARAM lParam; /* LONG message parameter */
108 };
109
110 /* The windows custom window manager information structure */
111 typedef struct {
112 SDL_version version;
113 HWND window; /* The Win32 display window */
114 } SDL_SysWMinfo;
115
116 #else
117
118 /* The generic custom event structure */
119 struct SDL_SysWMmsg {
120 SDL_version version;
121 int data;
122 };
123
124 /* The generic custom window manager information structure */
125 typedef struct {
126 SDL_version version;
127 int data;
128 } SDL_SysWMinfo;
129
130 #endif /* OS type */
131
132 #endif /* SDL_PROTOTYPES_ONLY */
133
134 /* Function prototypes */
135 /*
136 * This function gives you custom hooks into the window manager information.
137 * It fills the structure pointed to by 'info' with custom information and
138 * returns 1 if the function is implemented. If it's not implemented, or
139 * the version member of the 'info' structure is invalid, it returns 0.
140 */
141 extern DECLSPEC int SDL_GetWMInfo(SDL_SysWMinfo *info);
142
143
144 /* Ends C function definitions when using C++ */
145 #ifdef __cplusplus
146 }
147 #endif
148 #include "close_code.h"
149
150 #endif /* _SDL_syswm_h */