Mercurial > sdl-ios-xcode
annotate include/SDL_syswm.h @ 1312:c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
I batch edited these files, so please let me know if I've accidentally removed anybody's
credit here.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Wed, 01 Feb 2006 06:32:25 +0000 |
| parents | 609c060fd2a2 |
| children | 450721ad5436 |
| 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 | |
| 28 #include "SDL_version.h" | |
| 29 | |
| 30 #include "begin_code.h" | |
| 31 /* Set up for C function definitions, even when using C++ */ | |
| 32 #ifdef __cplusplus | |
| 33 extern "C" { | |
| 34 #endif | |
| 35 | |
| 36 /* Your application has access to a special type of event 'SDL_SYSWMEVENT', | |
| 37 which contains window-manager specific information and arrives whenever | |
| 38 an unhandled window event occurs. This event is ignored by default, but | |
| 39 you can enable it with SDL_EventState() | |
| 40 */ | |
| 41 #ifdef SDL_PROTOTYPES_ONLY | |
| 42 struct SDL_SysWMinfo; | |
| 43 typedef struct SDL_SysWMinfo SDL_SysWMinfo; | |
| 44 #else | |
| 45 | |
|
1133
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
46 #if defined(__APPLE__) && defined(__MACH__) |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
47 // conflicts with Quickdraw.h |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
48 #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
|
49 #endif |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
50 |
| 0 | 51 /* This is the structure for custom window manager events */ |
|
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 #if (defined(unix) || defined(__unix__) || defined(_AIX) || \ |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
53 defined(__OpenBSD__) || defined(__NetBSD__) || \ |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
54 (defined(__APPLE__) && defined(__MACH__))) && \ |
|
870
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
55 (!defined(DISABLE_X11) && !defined(__CYGWIN32__) && !defined(ENABLE_NANOX) && \ |
|
1133
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
56 !defined(__QNXNTO__)) |
| 0 | 57 /* AIX is unix, of course, but the native compiler CSet doesn't define unix */ |
| 58 #include <X11/Xlib.h> | |
| 59 #include <X11/Xatom.h> | |
| 60 | |
|
1133
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
61 #if defined(__APPLE__) && defined(__MACH__) |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
62 // matches the re-define above |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
63 #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
|
64 #endif |
|
609c060fd2a2
The MacOSX Carbon/Cocoa/X11 all in one library patch. Relevant emails:
Ryan C. Gordon <icculus@icculus.org>
parents:
1035
diff
changeset
|
65 |
| 0 | 66 /* These are the various supported subsystems under UNIX */ |
| 67 typedef enum { | |
| 68 SDL_SYSWM_X11 | |
| 69 } SDL_SYSWM_TYPE; | |
| 70 | |
| 71 /* The UNIX custom event structure */ | |
| 72 struct SDL_SysWMmsg { | |
| 73 SDL_version version; | |
| 74 SDL_SYSWM_TYPE subsystem; | |
| 75 union { | |
| 76 XEvent xevent; | |
| 77 } event; | |
| 78 }; | |
| 79 | |
| 80 /* The UNIX custom window manager information structure. | |
| 81 When this structure is returned, it holds information about which | |
| 82 low level system it is using, and will be one of SDL_SYSWM_TYPE. | |
| 83 */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
870
diff
changeset
|
84 typedef struct SDL_SysWMinfo { |
| 0 | 85 SDL_version version; |
| 86 SDL_SYSWM_TYPE subsystem; | |
| 87 union { | |
| 88 struct { | |
| 89 Display *display; /* The X11 display */ | |
| 90 Window window; /* The X11 display window */ | |
| 91 /* These locking functions should be called around | |
| 92 any X11 functions using the display variable. | |
| 93 They lock the event thread, so should not be | |
| 94 called around event functions or from event filters. | |
| 95 */ | |
| 96 void (*lock_func)(void); | |
| 97 void (*unlock_func)(void); | |
| 98 | |
| 99 /* Introduced in SDL 1.0.2 */ | |
| 100 Window fswindow; /* The X11 fullscreen window */ | |
| 101 Window wmwindow; /* The X11 managed input window */ | |
| 102 } x11; | |
| 103 } info; | |
| 104 } SDL_SysWMinfo; | |
| 105 | |
|
30
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
106 #elif defined(ENABLE_NANOX) |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
107 #include <microwin/nano-X.h> |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
108 |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
109 /* The generic custom event structure */ |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
110 struct SDL_SysWMmsg { |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
111 SDL_version version; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
112 int data; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
113 }; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
114 |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
115 /* 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
|
116 typedef struct SDL_SysWMinfo { |
|
30
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
117 SDL_version version ; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
118 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
|
119 } SDL_SysWMinfo; |
|
57bf11a5efd7
Added initial support for Nano-X (thanks Hsieh-Fu!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
120 |
| 0 | 121 #elif defined(WIN32) |
|
438
f9c5f135a8b9
Added a way to get the Windows OpenGL context in SDL_syswm.h
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
122 #define WIN32_LEAN_AND_MEAN |
| 0 | 123 #include <windows.h> |
| 124 | |
| 125 /* The windows custom event structure */ | |
| 126 struct SDL_SysWMmsg { | |
| 127 SDL_version version; | |
| 128 HWND hwnd; /* The window for the message */ | |
| 129 UINT msg; /* The type of message */ | |
| 130 WPARAM wParam; /* WORD message parameter */ | |
| 131 LPARAM lParam; /* LONG message parameter */ | |
| 132 }; | |
| 133 | |
| 134 /* 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
|
135 typedef struct SDL_SysWMinfo { |
| 0 | 136 SDL_version version; |
| 137 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
|
138 HGLRC hglrc; /* The OpenGL context, if any */ |
| 0 | 139 } SDL_SysWMinfo; |
| 140 | |
|
630
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
141 #elif defined(__riscos__) |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
142 |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
143 /* RISC OS custom event structure */ |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
144 struct SDL_SysWMmsg { |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
145 SDL_version version; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
146 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
|
147 int pollBlock[64]; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
148 }; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
149 |
|
1035
974ba6ae0fa3
Date: Wed, 26 Jan 2005 13:37:09 GMT
Sam Lantinga <slouken@libsdl.org>
parents:
1026
diff
changeset
|
150 /* 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
|
151 typedef struct SDL_SysWMinfo { |
|
630
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
152 SDL_version version; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
153 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
|
154 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
|
155 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
|
156 } SDL_SysWMinfo; |
|
550bccdf04bd
Added initial support for RISC OS (thanks Peter Naulls!)
Sam Lantinga <slouken@libsdl.org>
parents:
471
diff
changeset
|
157 |
|
870
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
158 #elif defined(__QNXNTO__) |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
159 #include <sys/neutrino.h> |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
160 #include <Ph.h> |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
161 |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
162 /* The QNX custom event structure */ |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
163 struct SDL_SysWMmsg { |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
164 SDL_version version; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
165 int data; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
166 }; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
167 |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
168 /* 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
|
169 typedef struct SDL_SysWMinfo { |
|
870
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
170 SDL_version version; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
171 int data; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
172 } SDL_SysWMinfo; |
|
95f22f17e44a
Date: Wed, 3 Mar 2004 12:44:21 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
173 |
| 0 | 174 #else |
| 175 | |
| 176 /* The generic custom event structure */ | |
| 177 struct SDL_SysWMmsg { | |
| 178 SDL_version version; | |
| 179 int data; | |
| 180 }; | |
| 181 | |
| 182 /* 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
|
183 typedef struct SDL_SysWMinfo { |
| 0 | 184 SDL_version version; |
| 185 int data; | |
| 186 } SDL_SysWMinfo; | |
| 187 | |
| 188 #endif /* OS type */ | |
| 189 | |
| 190 #endif /* SDL_PROTOTYPES_ONLY */ | |
| 191 | |
| 192 /* Function prototypes */ | |
| 193 /* | |
| 194 * This function gives you custom hooks into the window manager information. | |
| 195 * It fills the structure pointed to by 'info' with custom information and | |
| 196 * returns 1 if the function is implemented. If it's not implemented, or | |
| 197 * 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
|
198 * |
|
8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
199 * You typically use this function like this: |
|
8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
200 * SDL_SysWMInfo info; |
|
8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
201 * SDL_VERSION(&info.version); |
|
8be85fa59cf3
Added a usage example for SDL_GetWMInfo()
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
202 * if ( SDL_GetWMInfo(&info) ) { ... } |
| 0 | 203 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
204 extern DECLSPEC int SDLCALL SDL_GetWMInfo(SDL_SysWMinfo *info); |
| 0 | 205 |
| 206 | |
| 207 /* Ends C function definitions when using C++ */ | |
| 208 #ifdef __cplusplus | |
| 209 } | |
| 210 #endif | |
| 211 #include "close_code.h" | |
| 212 | |
| 213 #endif /* _SDL_syswm_h */ |