Mercurial > sdl-ios-xcode
annotate include/SDL_events.h @ 1335:c39265384763
SDL_config.h will eventually be a general feature set test,
which will be useful for any program built with SDL on a given platform.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Mon, 06 Feb 2006 17:28:04 +0000 |
| parents | 450721ad5436 |
| children | 67114343400d |
| 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:
1301
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:
1301
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:
1301
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:
1301
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:
1301
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:
1301
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:
1301
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:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 23 /* Include file for SDL event handling */ | |
| 24 | |
| 25 #ifndef _SDL_events_h | |
| 26 #define _SDL_events_h | |
| 27 | |
| 28 #include "SDL_types.h" | |
| 29 #include "SDL_active.h" | |
| 30 #include "SDL_keyboard.h" | |
| 31 #include "SDL_mouse.h" | |
| 32 #include "SDL_joystick.h" | |
| 33 #include "SDL_quit.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 | |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
41 /* General keyboard/mouse state definitions */ |
|
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
42 #define SDL_RELEASED 0 |
|
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
43 #define SDL_PRESSED 1 |
|
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
44 |
| 0 | 45 /* Event enumerations */ |
|
1294
1760ceb23bc6
Date: Fri, 18 Feb 2005 20:49:35 +0200 (EET)
Sam Lantinga <slouken@libsdl.org>
parents:
1258
diff
changeset
|
46 typedef enum { |
|
1760ceb23bc6
Date: Fri, 18 Feb 2005 20:49:35 +0200 (EET)
Sam Lantinga <slouken@libsdl.org>
parents:
1258
diff
changeset
|
47 SDL_NOEVENT = 0, /* Unused (do not remove) */ |
| 0 | 48 SDL_ACTIVEEVENT, /* Application loses/gains visibility */ |
| 49 SDL_KEYDOWN, /* Keys pressed */ | |
| 50 SDL_KEYUP, /* Keys released */ | |
| 51 SDL_MOUSEMOTION, /* Mouse moved */ | |
| 52 SDL_MOUSEBUTTONDOWN, /* Mouse button pressed */ | |
| 53 SDL_MOUSEBUTTONUP, /* Mouse button released */ | |
| 54 SDL_JOYAXISMOTION, /* Joystick axis motion */ | |
| 55 SDL_JOYBALLMOTION, /* Joystick trackball motion */ | |
| 56 SDL_JOYHATMOTION, /* Joystick hat position change */ | |
| 57 SDL_JOYBUTTONDOWN, /* Joystick button pressed */ | |
| 58 SDL_JOYBUTTONUP, /* Joystick button released */ | |
| 59 SDL_QUIT, /* User-requested quit */ | |
| 60 SDL_SYSWMEVENT, /* System specific event */ | |
| 61 SDL_EVENT_RESERVEDA, /* Reserved for future use.. */ | |
| 62 SDL_EVENT_RESERVEDB, /* Reserved for future use.. */ | |
| 63 SDL_VIDEORESIZE, /* User resized video mode */ | |
| 64 SDL_VIDEOEXPOSE, /* Screen needs to be redrawn */ | |
| 65 SDL_EVENT_RESERVED2, /* Reserved for future use.. */ | |
| 66 SDL_EVENT_RESERVED3, /* Reserved for future use.. */ | |
| 67 SDL_EVENT_RESERVED4, /* Reserved for future use.. */ | |
| 68 SDL_EVENT_RESERVED5, /* Reserved for future use.. */ | |
| 69 SDL_EVENT_RESERVED6, /* Reserved for future use.. */ | |
| 70 SDL_EVENT_RESERVED7, /* Reserved for future use.. */ | |
| 71 /* Events SDL_USEREVENT through SDL_MAXEVENTS-1 are for your use */ | |
| 72 SDL_USEREVENT = 24, | |
| 73 /* This last event is only for bounding internal arrays | |
| 74 It is the number of bits in the event mask datatype -- Uint32 | |
| 75 */ | |
| 76 SDL_NUMEVENTS = 32 | |
|
1294
1760ceb23bc6
Date: Fri, 18 Feb 2005 20:49:35 +0200 (EET)
Sam Lantinga <slouken@libsdl.org>
parents:
1258
diff
changeset
|
77 } SDL_EventType; |
| 0 | 78 |
| 79 /* Predefined event masks */ | |
| 80 #define SDL_EVENTMASK(X) (1<<(X)) | |
|
1294
1760ceb23bc6
Date: Fri, 18 Feb 2005 20:49:35 +0200 (EET)
Sam Lantinga <slouken@libsdl.org>
parents:
1258
diff
changeset
|
81 typedef enum { |
| 0 | 82 SDL_ACTIVEEVENTMASK = SDL_EVENTMASK(SDL_ACTIVEEVENT), |
| 83 SDL_KEYDOWNMASK = SDL_EVENTMASK(SDL_KEYDOWN), | |
| 84 SDL_KEYUPMASK = SDL_EVENTMASK(SDL_KEYUP), | |
|
1297
7b32c7a586c9
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1294
diff
changeset
|
85 SDL_KEYEVENTMASK = SDL_EVENTMASK(SDL_KEYDOWN)| |
| 1301 | 86 SDL_EVENTMASK(SDL_KEYUP), |
| 0 | 87 SDL_MOUSEMOTIONMASK = SDL_EVENTMASK(SDL_MOUSEMOTION), |
| 88 SDL_MOUSEBUTTONDOWNMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN), | |
| 89 SDL_MOUSEBUTTONUPMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONUP), | |
| 90 SDL_MOUSEEVENTMASK = SDL_EVENTMASK(SDL_MOUSEMOTION)| | |
| 91 SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN)| | |
| 92 SDL_EVENTMASK(SDL_MOUSEBUTTONUP), | |
| 93 SDL_JOYAXISMOTIONMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION), | |
| 94 SDL_JOYBALLMOTIONMASK = SDL_EVENTMASK(SDL_JOYBALLMOTION), | |
| 95 SDL_JOYHATMOTIONMASK = SDL_EVENTMASK(SDL_JOYHATMOTION), | |
| 96 SDL_JOYBUTTONDOWNMASK = SDL_EVENTMASK(SDL_JOYBUTTONDOWN), | |
| 97 SDL_JOYBUTTONUPMASK = SDL_EVENTMASK(SDL_JOYBUTTONUP), | |
| 98 SDL_JOYEVENTMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION)| | |
| 99 SDL_EVENTMASK(SDL_JOYBALLMOTION)| | |
| 100 SDL_EVENTMASK(SDL_JOYHATMOTION)| | |
| 101 SDL_EVENTMASK(SDL_JOYBUTTONDOWN)| | |
| 102 SDL_EVENTMASK(SDL_JOYBUTTONUP), | |
| 103 SDL_VIDEORESIZEMASK = SDL_EVENTMASK(SDL_VIDEORESIZE), | |
| 104 SDL_VIDEOEXPOSEMASK = SDL_EVENTMASK(SDL_VIDEOEXPOSE), | |
| 105 SDL_QUITMASK = SDL_EVENTMASK(SDL_QUIT), | |
| 106 SDL_SYSWMEVENTMASK = SDL_EVENTMASK(SDL_SYSWMEVENT) | |
|
1294
1760ceb23bc6
Date: Fri, 18 Feb 2005 20:49:35 +0200 (EET)
Sam Lantinga <slouken@libsdl.org>
parents:
1258
diff
changeset
|
107 } SDL_EventMask ; |
| 0 | 108 #define SDL_ALLEVENTS 0xFFFFFFFF |
| 109 | |
| 110 /* Application visibility event structure */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
111 typedef struct SDL_ActiveEvent { |
| 0 | 112 Uint8 type; /* SDL_ACTIVEEVENT */ |
| 113 Uint8 gain; /* Whether given states were gained or lost (1/0) */ | |
| 114 Uint8 state; /* A mask of the focus states */ | |
| 115 } SDL_ActiveEvent; | |
| 116 | |
| 117 /* Keyboard event structure */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
118 typedef struct SDL_KeyboardEvent { |
| 0 | 119 Uint8 type; /* SDL_KEYDOWN or SDL_KEYUP */ |
| 120 Uint8 which; /* The keyboard device index */ | |
| 121 Uint8 state; /* SDL_PRESSED or SDL_RELEASED */ | |
| 122 SDL_keysym keysym; | |
| 123 } SDL_KeyboardEvent; | |
| 124 | |
| 125 /* Mouse motion event structure */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
126 typedef struct SDL_MouseMotionEvent { |
| 0 | 127 Uint8 type; /* SDL_MOUSEMOTION */ |
| 128 Uint8 which; /* The mouse device index */ | |
| 129 Uint8 state; /* The current button state */ | |
| 130 Uint16 x, y; /* The X/Y coordinates of the mouse */ | |
| 131 Sint16 xrel; /* The relative motion in the X direction */ | |
| 132 Sint16 yrel; /* The relative motion in the Y direction */ | |
| 133 } SDL_MouseMotionEvent; | |
| 134 | |
| 135 /* Mouse button event structure */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
136 typedef struct SDL_MouseButtonEvent { |
| 0 | 137 Uint8 type; /* SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP */ |
| 138 Uint8 which; /* The mouse device index */ | |
| 139 Uint8 button; /* The mouse button index */ | |
| 140 Uint8 state; /* SDL_PRESSED or SDL_RELEASED */ | |
| 141 Uint16 x, y; /* The X/Y coordinates of the mouse at press time */ | |
| 142 } SDL_MouseButtonEvent; | |
| 143 | |
| 144 /* Joystick axis motion event structure */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
145 typedef struct SDL_JoyAxisEvent { |
| 0 | 146 Uint8 type; /* SDL_JOYAXISMOTION */ |
| 147 Uint8 which; /* The joystick device index */ | |
| 148 Uint8 axis; /* The joystick axis index */ | |
| 149 Sint16 value; /* The axis value (range: -32768 to 32767) */ | |
| 150 } SDL_JoyAxisEvent; | |
| 151 | |
| 152 /* Joystick trackball motion event structure */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
153 typedef struct SDL_JoyBallEvent { |
| 0 | 154 Uint8 type; /* SDL_JOYBALLMOTION */ |
| 155 Uint8 which; /* The joystick device index */ | |
| 156 Uint8 ball; /* The joystick trackball index */ | |
| 157 Sint16 xrel; /* The relative motion in the X direction */ | |
| 158 Sint16 yrel; /* The relative motion in the Y direction */ | |
| 159 } SDL_JoyBallEvent; | |
| 160 | |
| 161 /* Joystick hat position change event structure */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
162 typedef struct SDL_JoyHatEvent { |
| 0 | 163 Uint8 type; /* SDL_JOYHATMOTION */ |
| 164 Uint8 which; /* The joystick device index */ | |
| 165 Uint8 hat; /* The joystick hat index */ | |
| 166 Uint8 value; /* The hat position value: | |
|
577
f7596a8a3b8b
Fixed header docs for the joystick hat position
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
167 SDL_HAT_LEFTUP SDL_HAT_UP SDL_HAT_RIGHTUP |
|
f7596a8a3b8b
Fixed header docs for the joystick hat position
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
168 SDL_HAT_LEFT SDL_HAT_CENTERED SDL_HAT_RIGHT |
|
f7596a8a3b8b
Fixed header docs for the joystick hat position
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
169 SDL_HAT_LEFTDOWN SDL_HAT_DOWN SDL_HAT_RIGHTDOWN |
| 0 | 170 Note that zero means the POV is centered. |
| 171 */ | |
| 172 } SDL_JoyHatEvent; | |
| 173 | |
| 174 /* Joystick button event structure */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
175 typedef struct SDL_JoyButtonEvent { |
| 0 | 176 Uint8 type; /* SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP */ |
| 177 Uint8 which; /* The joystick device index */ | |
| 178 Uint8 button; /* The joystick button index */ | |
| 179 Uint8 state; /* SDL_PRESSED or SDL_RELEASED */ | |
| 180 } SDL_JoyButtonEvent; | |
| 181 | |
| 182 /* The "window resized" event | |
| 183 When you get this event, you are responsible for setting a new video | |
| 184 mode with the new width and height. | |
| 185 */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
186 typedef struct SDL_ResizeEvent { |
| 0 | 187 Uint8 type; /* SDL_VIDEORESIZE */ |
| 188 int w; /* New width */ | |
| 189 int h; /* New height */ | |
| 190 } SDL_ResizeEvent; | |
| 191 | |
| 192 /* The "screen redraw" event */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
193 typedef struct SDL_ExposeEvent { |
| 0 | 194 Uint8 type; /* SDL_VIDEOEXPOSE */ |
| 195 } SDL_ExposeEvent; | |
| 196 | |
| 197 /* The "quit requested" event */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
198 typedef struct SDL_QuitEvent { |
| 0 | 199 Uint8 type; /* SDL_QUIT */ |
| 200 } SDL_QuitEvent; | |
| 201 | |
| 202 /* A user-defined event type */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
203 typedef struct SDL_UserEvent { |
| 0 | 204 Uint8 type; /* SDL_USEREVENT through SDL_NUMEVENTS-1 */ |
| 205 int code; /* User defined event code */ | |
| 206 void *data1; /* User defined data pointer */ | |
| 207 void *data2; /* User defined data pointer */ | |
| 208 } SDL_UserEvent; | |
| 209 | |
| 210 /* If you want to use this event, you should include SDL_syswm.h */ | |
| 211 struct SDL_SysWMmsg; | |
| 212 typedef struct SDL_SysWMmsg SDL_SysWMmsg; | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
844
diff
changeset
|
213 typedef struct SDL_SysWMEvent { |
| 0 | 214 Uint8 type; |
| 215 SDL_SysWMmsg *msg; | |
| 216 } SDL_SysWMEvent; | |
| 217 | |
| 218 /* General event structure */ | |
|
1258
b2283b0ded26
Date: Thu, 19 Jan 2006 20:02:29 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
219 typedef union SDL_Event { |
| 0 | 220 Uint8 type; |
| 221 SDL_ActiveEvent active; | |
| 222 SDL_KeyboardEvent key; | |
| 223 SDL_MouseMotionEvent motion; | |
| 224 SDL_MouseButtonEvent button; | |
| 225 SDL_JoyAxisEvent jaxis; | |
| 226 SDL_JoyBallEvent jball; | |
| 227 SDL_JoyHatEvent jhat; | |
| 228 SDL_JoyButtonEvent jbutton; | |
| 229 SDL_ResizeEvent resize; | |
| 230 SDL_ExposeEvent expose; | |
| 231 SDL_QuitEvent quit; | |
| 232 SDL_UserEvent user; | |
| 233 SDL_SysWMEvent syswm; | |
| 234 } SDL_Event; | |
| 235 | |
| 236 | |
| 237 /* Function prototypes */ | |
| 238 | |
| 239 /* Pumps the event loop, gathering events from the input devices. | |
| 240 This function updates the event queue and internal input device state. | |
| 241 This should only be run in the thread that sets the video mode. | |
| 242 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
243 extern DECLSPEC void SDLCALL SDL_PumpEvents(void); |
| 0 | 244 |
| 245 /* Checks the event queue for messages and optionally returns them. | |
| 246 If 'action' is SDL_ADDEVENT, up to 'numevents' events will be added to | |
| 247 the back of the event queue. | |
| 248 If 'action' is SDL_PEEKEVENT, up to 'numevents' events at the front | |
| 249 of the event queue, matching 'mask', will be returned and will not | |
| 250 be removed from the queue. | |
| 251 If 'action' is SDL_GETEVENT, up to 'numevents' events at the front | |
| 252 of the event queue, matching 'mask', will be returned and will be | |
| 253 removed from the queue. | |
| 254 This function returns the number of events actually stored, or -1 | |
| 255 if there was an error. This function is thread-safe. | |
| 256 */ | |
| 257 typedef enum { | |
| 258 SDL_ADDEVENT, | |
| 259 SDL_PEEKEVENT, | |
| 260 SDL_GETEVENT | |
| 261 } SDL_eventaction; | |
| 262 /* */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
263 extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event *events, int numevents, |
| 0 | 264 SDL_eventaction action, Uint32 mask); |
| 265 | |
| 266 /* Polls for currently pending events, and returns 1 if there are any pending | |
| 267 events, or 0 if there are none available. If 'event' is not NULL, the next | |
| 268 event is removed from the queue and stored in that area. | |
| 269 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
270 extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event *event); |
| 0 | 271 |
| 272 /* Waits indefinitely for the next available event, returning 1, or 0 if there | |
| 273 was an error while waiting for events. If 'event' is not NULL, the next | |
| 274 event is removed from the queue and stored in that area. | |
| 275 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
276 extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event *event); |
| 0 | 277 |
| 278 /* Add an event to the event queue. | |
|
844
cd0c77df70a4
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
279 This function returns 0 on success, or -1 if the event queue was full |
|
cd0c77df70a4
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
280 or there was some other error. |
| 0 | 281 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
282 extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event *event); |
| 0 | 283 |
| 284 /* | |
| 285 This function sets up a filter to process all events before they | |
| 286 change internal state and are posted to the internal event queue. | |
| 287 | |
| 288 The filter is protypted as: | |
| 289 */ | |
|
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
290 typedef int (SDLCALL *SDL_EventFilter)(const SDL_Event *event); |
| 0 | 291 /* |
| 292 If the filter returns 1, then the event will be added to the internal queue. | |
| 293 If it returns 0, then the event will be dropped from the queue, but the | |
| 294 internal state will still be updated. This allows selective filtering of | |
| 295 dynamically arriving events. | |
| 296 | |
| 297 WARNING: Be very careful of what you do in the event filter function, as | |
| 298 it may run in a different thread! | |
| 299 | |
| 300 There is one caveat when dealing with the SDL_QUITEVENT event type. The | |
| 301 event filter is only called when the window manager desires to close the | |
| 302 application window. If the event filter returns 1, then the window will | |
| 303 be closed, otherwise the window will remain open if possible. | |
| 304 If the quit event is generated by an interrupt signal, it will bypass the | |
| 305 internal queue and be delivered to the application at the next event poll. | |
| 306 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
307 extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter); |
| 0 | 308 |
| 309 /* | |
| 310 Return the current event filter - can be used to "chain" filters. | |
| 311 If there is no event filter set, this function returns NULL. | |
| 312 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
313 extern DECLSPEC SDL_EventFilter SDLCALL SDL_GetEventFilter(void); |
| 0 | 314 |
| 315 /* | |
| 316 This function allows you to set the state of processing certain events. | |
| 317 If 'state' is set to SDL_IGNORE, that event will be automatically dropped | |
| 318 from the event queue and will not event be filtered. | |
| 319 If 'state' is set to SDL_ENABLE, that event will be processed normally. | |
| 320 If 'state' is set to SDL_QUERY, SDL_EventState() will return the | |
| 321 current processing state of the specified event. | |
| 322 */ | |
| 323 #define SDL_QUERY -1 | |
| 324 #define SDL_IGNORE 0 | |
| 325 #define SDL_DISABLE 0 | |
| 326 #define SDL_ENABLE 1 | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
327 extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint8 type, int state); |
| 0 | 328 |
| 329 | |
| 330 /* Ends C function definitions when using C++ */ | |
| 331 #ifdef __cplusplus | |
| 332 } | |
| 333 #endif | |
| 334 #include "close_code.h" | |
| 335 | |
| 336 #endif /* _SDL_events_h */ |