This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_events.h
462 lines (416 loc) · 16 KB
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
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
14
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
*/
23
24
25
26
27
/**
* \file SDL_events.h
*
* Include file for SDL event handling
*/
28
29
30
31
#ifndef _SDL_events_h
#define _SDL_events_h
32
#include "SDL_stdinc.h"
33
#include "SDL_error.h"
34
#include "SDL_video.h"
35
36
37
38
39
40
41
42
#include "SDL_keyboard.h"
#include "SDL_mouse.h"
#include "SDL_joystick.h"
#include "SDL_quit.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
43
/* *INDENT-OFF* */
44
extern "C" {
45
/* *INDENT-ON* */
46
47
#endif
48
49
50
51
/* General keyboard/mouse state definitions */
#define SDL_RELEASED 0
#define SDL_PRESSED 1
52
53
54
55
56
57
58
59
60
61
62
/**
* \enum SDL_EventType
*
* \brief The types of events that can be delivered
*/
typedef enum
{
SDL_NOEVENT = 0, /**< Unused (do not remove) */
SDL_WINDOWEVENT, /**< Window state change */
SDL_KEYDOWN, /**< Keys pressed */
SDL_KEYUP, /**< Keys released */
63
SDL_TEXTINPUT, /**< Keyboard text input */
64
65
66
SDL_MOUSEMOTION, /**< Mouse moved */
SDL_MOUSEBUTTONDOWN, /**< Mouse button pressed */
SDL_MOUSEBUTTONUP, /**< Mouse button released */
67
SDL_MOUSEWHEEL, /**< Mouse wheel motion */
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
SDL_JOYAXISMOTION, /**< Joystick axis motion */
SDL_JOYBALLMOTION, /**< Joystick trackball motion */
SDL_JOYHATMOTION, /**< Joystick hat position change */
SDL_JOYBUTTONDOWN, /**< Joystick button pressed */
SDL_JOYBUTTONUP, /**< Joystick button released */
SDL_QUIT, /**< User-requested quit */
SDL_SYSWMEVENT, /**< System specific event */
SDL_EVENT_RESERVED1, /**< Reserved for future use... */
SDL_EVENT_RESERVED2, /**< Reserved for future use... */
SDL_EVENT_RESERVED3, /**< Reserved for future use... */
/* Events SDL_USEREVENT through SDL_MAXEVENTS-1 are for your use */
SDL_USEREVENT = 24,
/* This last event is only for bounding internal arrays
It is the number of bits in the event mask datatype -- Uint32
*/
SDL_NUMEVENTS = 32
84
} SDL_EventType;
85
86
87
88
89
90
/**
* \enum SDL_EventMask
*
* \brief Predefined event masks
*/
91
#define SDL_EVENTMASK(X) (1<<(X))
92
93
typedef enum
{
94
95
96
97
SDL_WINDOWEVENTMASK = SDL_EVENTMASK(SDL_WINDOWEVENT),
SDL_KEYDOWNMASK = SDL_EVENTMASK(SDL_KEYDOWN),
SDL_KEYUPMASK = SDL_EVENTMASK(SDL_KEYUP),
SDL_KEYEVENTMASK = SDL_EVENTMASK(SDL_KEYDOWN) | SDL_EVENTMASK(SDL_KEYUP),
98
SDL_TEXTINPUTMASK = SDL_EVENTMASK(SDL_TEXTINPUT),
99
100
101
SDL_MOUSEMOTIONMASK = SDL_EVENTMASK(SDL_MOUSEMOTION),
SDL_MOUSEBUTTONDOWNMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN),
SDL_MOUSEBUTTONUPMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
102
SDL_MOUSEWHEELMASK = SDL_EVENTMASK(SDL_MOUSEWHEEL),
103
104
105
106
107
108
109
110
111
112
113
114
115
SDL_MOUSEEVENTMASK = SDL_EVENTMASK(SDL_MOUSEMOTION) |
SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN) | SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
SDL_JOYAXISMOTIONMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION),
SDL_JOYBALLMOTIONMASK = SDL_EVENTMASK(SDL_JOYBALLMOTION),
SDL_JOYHATMOTIONMASK = SDL_EVENTMASK(SDL_JOYHATMOTION),
SDL_JOYBUTTONDOWNMASK = SDL_EVENTMASK(SDL_JOYBUTTONDOWN),
SDL_JOYBUTTONUPMASK = SDL_EVENTMASK(SDL_JOYBUTTONUP),
SDL_JOYEVENTMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION) |
SDL_EVENTMASK(SDL_JOYBALLMOTION) |
SDL_EVENTMASK(SDL_JOYHATMOTION) |
SDL_EVENTMASK(SDL_JOYBUTTONDOWN) | SDL_EVENTMASK(SDL_JOYBUTTONUP),
SDL_QUITMASK = SDL_EVENTMASK(SDL_QUIT),
SDL_SYSWMEVENTMASK = SDL_EVENTMASK(SDL_SYSWMEVENT)
116
} SDL_EventMask;
117
118
#define SDL_ALLEVENTS 0xFFFFFFFF
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/**
* \struct SDL_WindowEvent
*
* \brief Window state change event data
*/
typedef struct SDL_WindowEvent
{
Uint8 type; /**< SDL_WINDOWEVENT */
Uint8 event; /**< SDL_WindowEventID */
int data1; /**< event dependent data */
int data2; /**< event dependent data */
SDL_WindowID windowID; /**< The associated window */
} SDL_WindowEvent;
/**
* \struct SDL_KeyboardEvent
*
136
* \brief Keyboard button event structure
137
138
139
140
141
142
143
144
*/
typedef struct SDL_KeyboardEvent
{
Uint8 type; /**< SDL_KEYDOWN or SDL_KEYUP */
Uint8 which; /**< The keyboard device index */
Uint8 state; /**< SDL_PRESSED or SDL_RELEASED */
SDL_keysym keysym; /**< The key that was pressed or released */
SDL_WindowID windowID; /**< The window with keyboard focus, if any */
145
146
} SDL_KeyboardEvent;
147
/**
148
* \struct SDL_TextInputEvent
149
*
150
* \brief Keyboard text input event structure
151
*/
152
typedef struct SDL_TextInputEvent
153
{
154
Uint8 type; /**< SDL_TEXTINPUT */
155
156
157
Uint8 which; /**< The keyboard device index */
char text[32]; /**< The input text */
SDL_WindowID windowID; /**< The window with keyboard focus, if any */
158
} SDL_TextInputEvent;
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/**
* \struct SDL_MouseMotionEvent
*
* \brief Mouse motion event structure
*/
typedef struct SDL_MouseMotionEvent
{
Uint8 type; /**< SDL_MOUSEMOTION */
Uint8 which; /**< The mouse device index */
Uint8 state; /**< The current button state */
int x; /**< X coordinate, relative to window */
int y; /**< Y coordinate, relative to window */
int xrel; /**< The relative motion in the X direction */
int yrel; /**< The relative motion in the Y direction */
SDL_WindowID windowID; /**< The window with mouse focus, if any */
175
176
} SDL_MouseMotionEvent;
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/**
* \struct SDL_MouseButtonEvent
*
* \brief Mouse button event structure
*/
typedef struct SDL_MouseButtonEvent
{
Uint8 type; /**< SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP */
Uint8 which; /**< The mouse device index */
Uint8 button; /**< The mouse button index */
Uint8 state; /**< SDL_PRESSED or SDL_RELEASED */
int x; /**< X coordinate, relative to window */
int y; /**< Y coordinate, relative to window */
SDL_WindowID windowID; /**< The window with mouse focus, if any */
191
192
} SDL_MouseButtonEvent;
193
194
195
196
197
198
199
200
201
202
203
204
205
/**
* \struct SDL_MouseWheelEvent
*
* \brief Mouse wheel event structure
*/
typedef struct SDL_MouseWheelEvent
{
Uint8 type; /**< SDL_MOUSEWHEEL */
Uint8 which; /**< The mouse device index */
int motion; /**< The direction and distance scrolled */
SDL_WindowID windowID; /**< The window with mouse focus, if any */
} SDL_MouseWheelEvent;
206
207
208
209
210
211
212
213
214
215
216
/**
* \struct SDL_JoyAxisEvent
*
* \brief Joystick axis motion event structure
*/
typedef struct SDL_JoyAxisEvent
{
Uint8 type; /**< SDL_JOYAXISMOTION */
Uint8 which; /**< The joystick device index */
Uint8 axis; /**< The joystick axis index */
int value; /**< The axis value (range: -32768 to 32767) */
217
218
} SDL_JoyAxisEvent;
219
220
221
222
223
224
225
226
227
228
229
230
/**
* \struct SDL_JoyBallEvent
*
* \brief Joystick trackball motion event structure
*/
typedef struct SDL_JoyBallEvent
{
Uint8 type; /**< SDL_JOYBALLMOTION */
Uint8 which; /**< The joystick device index */
Uint8 ball; /**< The joystick trackball index */
int xrel; /**< The relative motion in the X direction */
int yrel; /**< The relative motion in the Y direction */
231
232
} SDL_JoyBallEvent;
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/**
* \struct SDL_JoyHatEvent
*
* \brief Joystick hat position change event structure
*/
typedef struct SDL_JoyHatEvent
{
Uint8 type; /**< SDL_JOYHATMOTION */
Uint8 which; /**< The joystick device index */
Uint8 hat; /**< The joystick hat index */
Uint8 value; /**< The hat position value:
SDL_HAT_LEFTUP SDL_HAT_UP SDL_HAT_RIGHTUP
SDL_HAT_LEFT SDL_HAT_CENTERED SDL_HAT_RIGHT
SDL_HAT_LEFTDOWN SDL_HAT_DOWN SDL_HAT_RIGHTDOWN
Note that zero means the POV is centered.
*/
249
250
} SDL_JoyHatEvent;
251
252
253
254
255
256
257
258
259
260
261
/**
* \struct SDL_JoyButtonEvent
*
* \brief Joystick button event structure
*/
typedef struct SDL_JoyButtonEvent
{
Uint8 type; /**< SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP */
Uint8 which; /**< The joystick device index */
Uint8 button; /**< The joystick button index */
Uint8 state; /**< SDL_PRESSED or SDL_RELEASED */
262
263
} SDL_JoyButtonEvent;
264
265
266
267
/**
* \struct SDL_QuitEvent
*
* \brief The "quit requested" event
268
*/
269
270
271
typedef struct SDL_QuitEvent
{
Uint8 type; /**< SDL_QUIT */
272
273
} SDL_QuitEvent;
274
275
276
277
278
279
280
281
282
283
284
/**
* \struct SDL_UserEvent
*
* \brief A user-defined event type
*/
typedef struct SDL_UserEvent
{
Uint8 type; /**< SDL_USEREVENT through SDL_NUMEVENTS-1 */
int code; /**< User defined event code */
void *data1; /**< User defined data pointer */
void *data2; /**< User defined data pointer */
285
286
} SDL_UserEvent;
287
288
289
290
291
292
293
/**
* \struct SDL_SysWMEvent
*
* \brief A video driver dependent system event
*
* \note If you want to use this event, you should include SDL_syswm.h
*/
294
295
struct SDL_SysWMmsg;
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
296
297
298
299
typedef struct SDL_SysWMEvent
{
Uint8 type; /**< SDL_SYSWMEVENT */
SDL_SysWMmsg *msg; /**< driver dependent data, defined in SDL_syswm.h */
300
301
} SDL_SysWMEvent;
302
303
304
305
306
307
308
309
310
311
312
313
314
315
/* Typedefs for backwards compatibility */
typedef struct SDL_ActiveEvent
{
Uint8 type;
Uint8 gain;
Uint8 state;
} SDL_ActiveEvent;
typedef struct SDL_ResizeEvent
{
Uint8 type;
int w;
int h;
} SDL_ResizeEvent;
316
317
318
319
320
321
322
323
324
325
/**
* \union SDL_Event
*
* \brief General event structure
*/
typedef union SDL_Event
{
Uint8 type; /**< Event type, shared with all events */
SDL_WindowEvent window; /**< Window event data */
SDL_KeyboardEvent key; /**< Keyboard event data */
326
SDL_TextInputEvent text; /**< Text input event data */
327
328
SDL_MouseMotionEvent motion; /**< Mouse motion event data */
SDL_MouseButtonEvent button; /**< Mouse button event data */
329
SDL_MouseWheelEvent wheel; /**< Mouse wheel event data */
330
331
332
333
334
335
336
SDL_JoyAxisEvent jaxis; /**< Joystick axis event data */
SDL_JoyBallEvent jball; /**< Joystick ball event data */
SDL_JoyHatEvent jhat; /**< Joystick hat event data */
SDL_JoyButtonEvent jbutton; /**< Joystick button event data */
SDL_QuitEvent quit; /**< Quit request event data */
SDL_UserEvent user; /**< Custom event data */
SDL_SysWMEvent syswm; /**< System dependent window event data */
337
338
339
340
/* Temporarily here for backwards compatibility */
SDL_ActiveEvent active;
SDL_ResizeEvent resize;
341
342
343
344
345
346
347
348
349
} SDL_Event;
/* Function prototypes */
/* Pumps the event loop, gathering events from the input devices.
This function updates the event queue and internal input device state.
This should only be run in the thread that sets the video mode.
*/
350
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
351
352
353
354
355
356
357
358
359
360
361
362
363
/* Checks the event queue for messages and optionally returns them.
If 'action' is SDL_ADDEVENT, up to 'numevents' events will be added to
the back of the event queue.
If 'action' is SDL_PEEKEVENT, up to 'numevents' events at the front
of the event queue, matching 'mask', will be returned and will not
be removed from the queue.
If 'action' is SDL_GETEVENT, up to 'numevents' events at the front
of the event queue, matching 'mask', will be returned and will be
removed from the queue.
This function returns the number of events actually stored, or -1
if there was an error. This function is thread-safe.
*/
364
365
366
367
368
typedef enum
{
SDL_ADDEVENT,
SDL_PEEKEVENT,
SDL_GETEVENT
369
370
} SDL_eventaction;
/* */
371
372
373
extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
SDL_eventaction action,
Uint32 mask);
374
375
376
377
378
/* Checks to see if certain event types are in the event queue.
*/
extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 mask);
379
380
381
382
/* Polls for currently pending events, and returns 1 if there are any pending
events, or 0 if there are none available. If 'event' is not NULL, the next
event is removed from the queue and stored in that area.
*/
383
extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
384
385
386
387
388
/* Waits indefinitely for the next available event, returning 1, or 0 if there
was an error while waiting for events. If 'event' is not NULL, the next
event is removed from the queue and stored in that area.
*/
389
extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
390
391
/* Add an event to the event queue.
392
393
This function returns 1 on success, 0 if the event was filtered,
or -1 if the event queue was full or there was some other error.
394
*/
395
extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
396
397
398
399
400
401
402
/*
This function sets up a filter to process all events before they
change internal state and are posted to the internal event queue.
The filter is protypted as:
*/
403
typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
/*
If the filter returns 1, then the event will be added to the internal queue.
If it returns 0, then the event will be dropped from the queue, but the
internal state will still be updated. This allows selective filtering of
dynamically arriving events.
WARNING: Be very careful of what you do in the event filter function, as
it may run in a different thread!
There is one caveat when dealing with the SDL_QUITEVENT event type. The
event filter is only called when the window manager desires to close the
application window. If the event filter returns 1, then the window will
be closed, otherwise the window will remain open if possible.
If the quit event is generated by an interrupt signal, it will bypass the
internal queue and be delivered to the application at the next event poll.
*/
420
421
extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
void *userdata);
422
423
424
/*
Return the current event filter - can be used to "chain" filters.
425
If there is no event filter set, this function returns SDL_FALSE.
426
*/
427
428
extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
void **userdata);
429
430
431
432
433
434
435
/*
Run the filter function on the current event queue, removing any
events for which the filter returns 0.
*/
extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter,
void *userdata);
436
437
438
439
440
441
442
443
444
445
446
447
448
/*
This function allows you to set the state of processing certain events.
If 'state' is set to SDL_IGNORE, that event will be automatically dropped
from the event queue and will not event be filtered.
If 'state' is set to SDL_ENABLE, that event will be processed normally.
If 'state' is set to SDL_QUERY, SDL_EventState() will return the
current processing state of the specified event.
*/
#define SDL_QUERY -1
#define SDL_IGNORE 0
#define SDL_DISABLE 0
#define SDL_ENABLE 1
449
extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint8 type, int state);
450
451
452
453
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
454
/* *INDENT-OFF* */
455
}
456
/* *INDENT-ON* */
457
458
459
460
#endif
#include "close_code.h"
#endif /* _SDL_events_h */
461
462
/* vi: set ts=4 sw=4 expandtab: */