This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_events.h
511 lines (462 loc) · 18.2 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2009 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
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 */
75
76
SDL_PROXIMITYIN, /**< Proximity In event */
SDL_PROXIMITYOUT, /**< Proximity Out event */
77
SDL_EVENT_RESERVED1,
78
79
SDL_EVENT_RESERVED2,
SDL_EVENT_RESERVED3,
80
SDL_TEXTEDITING, /**< Reserved for future use... */
81
82
83
84
85
86
/* 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
87
} SDL_EventType;
88
89
90
91
92
93
/**
* \enum SDL_EventMask
*
* \brief Predefined event masks
*/
94
#define SDL_EVENTMASK(X) (1<<(X))
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
typedef enum
{
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),
SDL_TEXTINPUTMASK = SDL_EVENTMASK(SDL_TEXTINPUT),
SDL_MOUSEMOTIONMASK = SDL_EVENTMASK(SDL_MOUSEMOTION),
SDL_MOUSEBUTTONDOWNMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN),
SDL_MOUSEBUTTONUPMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
SDL_MOUSEWHEELMASK = SDL_EVENTMASK(SDL_MOUSEWHEEL),
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),
118
119
SDL_SYSWMEVENTMASK = SDL_EVENTMASK(SDL_SYSWMEVENT),
SDL_PROXIMITYINMASK = SDL_EVENTMASK(SDL_PROXIMITYIN),
120
121
SDL_PROXIMITYOUTMASK = SDL_EVENTMASK(SDL_PROXIMITYOUT),
SDL_TEXTEDITINGMASK = SDL_EVENTMASK(SDL_TEXTEDITING)
122
} SDL_EventMask;
123
124
#define SDL_ALLEVENTS 0xFFFFFFFF
125
126
127
/**
* \struct SDL_WindowEvent
*
128
* \brief Window state change event data (event.window.*)
129
130
131
132
133
134
135
136
137
138
139
140
141
*/
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
*
142
* \brief Keyboard button event structure (event.key.*)
143
144
145
146
147
148
149
150
*/
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 */
151
152
} SDL_KeyboardEvent;
153
154
155
/**
* \struct SDL_TextInputEvent
*
156
* \brief Keyboard text input event structure (event.text.*)
157
*/
158
#define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
159
160
typedef struct SDL_TextInputEvent
{
161
162
163
164
Uint8 type; /**< SDL_TEXTINPUT */
Uint8 which; /**< The keyboard device index */
char text[SDL_TEXTINPUTEVENT_TEXT_SIZE]; /**< The input text */
SDL_WindowID windowID; /**< The window with keyboard focus, if any */
165
166
} SDL_TextInputEvent;
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/**
* \struct SDL_TextEditingEvent
*
* \brief Keyboard text editing event structure (event.edit.*)
*/
#define SDL_TEXTEDITINGEVENT_TEXT_SIZE (32)
typedef struct SDL_TextEditingEvent
{
Uint8 type; /**< SDL_TEXTEDITING */
char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE]; /**< The editing text */
int start; /**< The start cursor of selected editing text */
int length; /**< The length of selected editing text */
} SDL_TextEditingEvent;
181
182
183
/**
* \struct SDL_MouseMotionEvent
*
184
* \brief Mouse motion event structure (event.motion.*)
185
186
187
188
189
190
191
192
*/
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 */
193
194
195
196
197
198
199
int z; /**< Z coordinate, for future use */
int pressure; /**< Pressure reported by tablets */
int pressure_max; /**< Maximum value of the pressure reported by the device */
int pressure_min; /**< Minimum value of the pressure reported by the device */
int rotation; /**< For future use */
int tilt; /**< For future use */
int cursor; /**< The cursor being used in the event */
200
201
202
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 */
203
204
} SDL_MouseMotionEvent;
205
206
207
/**
* \struct SDL_MouseButtonEvent
*
208
* \brief Mouse button event structure (event.button.*)
209
210
211
212
213
214
215
216
217
218
*/
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 */
219
220
} SDL_MouseButtonEvent;
221
222
223
/**
* \struct SDL_MouseWheelEvent
*
224
* \brief Mouse wheel event structure (event.wheel.*)
225
226
227
228
229
*/
typedef struct SDL_MouseWheelEvent
{
Uint8 type; /**< SDL_MOUSEWHEEL */
Uint8 which; /**< The mouse device index */
230
231
int x; /**< The amount scrolled horizontally */
int y; /**< The amount scrolled vertically */
232
233
234
235
236
237
SDL_WindowID windowID; /**< The window with mouse focus, if any */
} SDL_MouseWheelEvent;
/**
* \struct SDL_JoyAxisEvent
*
238
* \brief Joystick axis motion event structure (event.jaxis.*)
239
240
241
242
243
244
245
*/
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) */
246
247
} SDL_JoyAxisEvent;
248
249
250
/**
* \struct SDL_JoyBallEvent
*
251
* \brief Joystick trackball motion event structure (event.jball.*)
252
253
254
255
256
257
258
259
*/
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 */
260
261
} SDL_JoyBallEvent;
262
263
264
/**
* \struct SDL_JoyHatEvent
*
265
* \brief Joystick hat position change event structure (event.jhat.*)
266
267
268
269
270
271
272
273
274
275
276
277
*/
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.
*/
278
279
} SDL_JoyHatEvent;
280
281
282
/**
* \struct SDL_JoyButtonEvent
*
283
* \brief Joystick button event structure (event.jbutton.*)
284
285
286
287
288
289
290
*/
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 */
291
292
} SDL_JoyButtonEvent;
293
294
295
296
/**
* \struct SDL_QuitEvent
*
* \brief The "quit requested" event
297
*/
298
299
300
typedef struct SDL_QuitEvent
{
Uint8 type; /**< SDL_QUIT */
301
302
} SDL_QuitEvent;
303
304
305
/**
* \struct SDL_UserEvent
*
306
* \brief A user-defined event type (event.user.*)
307
308
309
*/
typedef struct SDL_UserEvent
{
310
311
312
313
314
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 */
SDL_WindowID windowID; /**< The associated window if any*/
315
316
} SDL_UserEvent;
317
318
319
/**
* \struct SDL_SysWMEvent
*
320
* \brief A video driver dependent system event (event.syswm.*)
321
322
323
*
* \note If you want to use this event, you should include SDL_syswm.h
*/
324
325
struct SDL_SysWMmsg;
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
326
327
328
329
typedef struct SDL_SysWMEvent
{
Uint8 type; /**< SDL_SYSWMEVENT */
SDL_SysWMmsg *msg; /**< driver dependent data, defined in SDL_syswm.h */
330
331
} SDL_SysWMEvent;
332
333
334
335
336
337
338
339
340
341
342
343
344
345
/* 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;
346
347
348
349
350
351
352
353
354
typedef struct SDL_ProximityEvent
{
Uint8 type;
Uint8 which;
int cursor;
int x;
int y;
} SDL_ProximityEvent;
355
356
357
358
359
360
361
362
363
364
/**
* \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 */
365
SDL_TextInputEvent text; /**< Text input event data */
366
367
SDL_MouseMotionEvent motion; /**< Mouse motion event data */
SDL_MouseButtonEvent button; /**< Mouse button event data */
368
SDL_MouseWheelEvent wheel; /**< Mouse wheel event data */
369
370
371
372
373
374
375
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 */
376
SDL_ProximityEvent proximity; /**< Proximity In or Out event */
377
SDL_TextEditingEvent edit; /**< Text editing event data */
378
379
380
381
/* Temporarily here for backwards compatibility */
SDL_ActiveEvent active;
SDL_ResizeEvent resize;
382
383
384
385
386
387
388
389
390
} 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.
*/
391
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
392
393
394
395
396
397
398
399
400
401
402
403
404
/* 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.
*/
405
406
407
408
409
typedef enum
{
SDL_ADDEVENT,
SDL_PEEKEVENT,
SDL_GETEVENT
410
411
} SDL_eventaction;
/* */
412
413
414
415
416
417
418
extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
SDL_eventaction action,
Uint32 mask);
/* Checks to see if certain event types are in the event queue.
*/
extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 mask);
419
420
421
422
423
/* 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.
*/
424
extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
425
426
427
428
429
/* 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.
*/
430
extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
431
432
433
434
435
436
437
438
439
/* Waits until the specified timeout (in milliseconds) 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.
*/
extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
int timeout);
440
/* Add an event to the event queue.
441
442
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.
443
*/
444
extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
445
446
447
448
449
450
451
/*
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:
*/
452
typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
/*
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.
*/
469
470
extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
void *userdata);
471
472
473
/*
Return the current event filter - can be used to "chain" filters.
474
If there is no event filter set, this function returns SDL_FALSE.
475
*/
476
477
478
479
480
481
482
483
484
extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
void **userdata);
/*
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);
485
486
487
488
489
490
491
492
493
494
495
496
497
/*
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
498
extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint8 type, int state);
499
500
501
502
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
503
/* *INDENT-OFF* */
504
}
505
/* *INDENT-ON* */
506
507
508
509
#endif
#include "close_code.h"
#endif /* _SDL_events_h */
510
511
/* vi: set ts=4 sw=4 expandtab: */