Mercurial > sdl-ios-xcode
annotate include/SDL_syswm.h @ 1622:5bbfc3e20e10
Fixed bug #191
[I opted to go for a warning, since I often tweak configure.in, but don't want to rebuild the entire project]
One thing that was lost in the switch from automake to the new build system is
that there is now no rule to build configure from configure.in.
IMHO, if configure.in gets changed, then at the very least, the build system
should print out a warning (better, again IMHO, an error) about this fact.
Else, you easily forget about this when modifying configure.in.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Thu, 13 Apr 2006 13:23:56 +0000 |
| parents | dc6b59e925a2 |
| children | a80e1e0880b8 |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1133
diff
changeset
|
3 Copyright (C) 1997-2006 Sam Lantinga |
| 0 | 4 |
| 5 This library is free software; you can redistribute it and/or | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1133
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
| 0 | 7 License as published by the Free Software Foundation; either |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1133
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
| 0 | 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 | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1133
diff
changeset
|
13 Lesser General Public License for more details. |
| 0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1133
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1133
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1133
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
94
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 23 /* Include file for SDL custom system window manager hooks */ | |
| 24 | |
| 25 #ifndef _SDL_syswm_h | |
| 26 #define _SDL_syswm_h | |
| 27 | |
|
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
28 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
29 #include "SDL_error.h" |
| 0 | 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 | |
|
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
48 /* This is the structure for custom window manager events */ |
|
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
49 #if SDL_VIDEO_DRIVER_X11 |
|
1133
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
50 #if defined(__APPLE__) && defined(__MACH__) |
|
1487
dc6b59e925a2
Cleaning up warnings on MacOS X
Sam Lantinga <slouken@libsdl.org>
parents:
1433
diff
changeset
|
51 /* conflicts with Quickdraw.h */ |
|
1133
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
52 #define Cursor X11Cursor |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
53 #endif |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
54 |
| 0 | 55 #include <X11/Xlib.h> |
| 56 #include <X11/Xatom.h> | |
| 57 | |
|
1133
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
58 #if defined(__APPLE__) && defined(__MACH__) |
|
1487
dc6b59e925a2
Cleaning up warnings on MacOS X
Sam Lantinga <slouken@libsdl.org>
parents:
1433
diff
changeset
|
59 /* matches the re-define above */ |
|
1133
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
60 #undef Cursor |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
61 #endif |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
62 |
| 0 | 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 */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
870
diff
changeset
|
81 typedef struct SDL_SysWMinfo { |
| 0 | 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 | |
|
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
103 #elif SDL_VIDEO_DRIVER_NANOX |
|
30
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
104 #include <microwin/nano-X.h> |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
105 |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
106 /* The generic custom event structure */ |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
107 struct SDL_SysWMmsg { |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
108 SDL_version version; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
109 int data; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
110 }; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
111 |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
112 /* The windows custom window manager information structure */ |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
870
diff
changeset
|
113 typedef struct SDL_SysWMinfo { |
|
30
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
114 SDL_version version ; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
115 GR_WINDOW_ID window ; /* The display window */ |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
116 } SDL_SysWMinfo; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
117 |
|
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
118 #elif SDL_VIDEO_DRIVER_WINDIB || SDL_VIDEO_DRIVER_DDRAW |
|
1433
bb6839704ed6
SDL_windows.h is no longer necessary
Sam Lantinga <slouken@libsdl.org>
parents:
1361
diff
changeset
|
119 #define WIN32_LEAN_AND_MEAN |
|
bb6839704ed6
SDL_windows.h is no longer necessary
Sam Lantinga <slouken@libsdl.org>
parents:
1361
diff
changeset
|
120 #include <windows.h> |
| 0 | 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 */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
870
diff
changeset
|
132 typedef struct SDL_SysWMinfo { |
| 0 | 133 SDL_version version; |
| 134 HWND window; /* The Win32 display window */ | |
|
438
f9c5f135a8b9
Added a way to get the Windows OpenGL context in SDL_syswm.h
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
135 HGLRC hglrc; /* The OpenGL context, if any */ |
| 0 | 136 } SDL_SysWMinfo; |
| 137 | |
|
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
138 #elif SDL_VIDEO_DRIVER_RISCOS |
|
630
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
139 |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
140 /* RISC OS custom event structure */ |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
141 struct SDL_SysWMmsg { |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
142 SDL_version version; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
143 int eventCode; /* The window for the message */ |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
144 int pollBlock[64]; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
145 }; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
146 |
|
1035
974ba6ae0fa3
Date: Wed, 26 Jan 2005 13:37:09 GMT
Sam Lantinga <slouken@libsdl.org>
parents:
1026
diff
changeset
|
147 /* The RISC OS custom window manager information structure */ |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
870
diff
changeset
|
148 typedef struct SDL_SysWMinfo { |
|
630
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
149 SDL_version version; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
150 int wimpVersion; /* Wimp version running under */ |
|
1035
974ba6ae0fa3
Date: Wed, 26 Jan 2005 13:37:09 GMT
Sam Lantinga <slouken@libsdl.org>
parents:
1026
diff
changeset
|
151 int taskHandle; /* The RISC OS task handle */ |
|
974ba6ae0fa3
Date: Wed, 26 Jan 2005 13:37:09 GMT
Sam Lantinga <slouken@libsdl.org>
parents:
1026
diff
changeset
|
152 int window; /* The RISC OS display window */ |
|
630
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
153 } SDL_SysWMinfo; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
154 |
|
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
155 #elif SDL_VIDEO_DRIVER_PHOTON |
|
870
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
156 #include <sys/neutrino.h> |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
157 #include <Ph.h> |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
158 |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
159 /* The QNX custom event structure */ |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
160 struct SDL_SysWMmsg { |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
161 SDL_version version; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
162 int data; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
163 }; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
164 |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
165 /* The QNX custom window manager information structure */ |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
870
diff
changeset
|
166 typedef struct SDL_SysWMinfo { |
|
870
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
167 SDL_version version; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
168 int data; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
169 } SDL_SysWMinfo; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
170 |
| 0 | 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 */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
870
diff
changeset
|
180 typedef struct SDL_SysWMinfo { |
| 0 | 181 SDL_version version; |
| 182 int data; | |
| 183 } SDL_SysWMinfo; | |
| 184 | |
|
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
185 #endif /* video driver type */ |
| 0 | 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. | |
|
999
8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
195 * |
|
8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
196 * You typically use this function like this: |
|
8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
197 * SDL_SysWMInfo info; |
|
8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
198 * SDL_VERSION(&info.version); |
|
8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
199 * if ( SDL_GetWMInfo(&info) ) { ... } |
| 0 | 200 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
201 extern DECLSPEC int SDLCALL SDL_GetWMInfo(SDL_SysWMinfo *info); |
| 0 | 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 */ |