This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_events.h
560 lines (497 loc) · 18.2 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2010 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
* \file SDL_events.h
*
* Include file for SDL event handling.
27
*/
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
* \brief The types of events that can be delivered.
54
55
56
*/
typedef enum
{
57
58
59
60
61
62
63
64
65
66
67
SDL_FIRSTEVENT = 0, /**< Unused (do not remove) */
/* Application events */
SDL_QUIT = 0x100, /**< User-requested quit */
/* Window events */
SDL_WINDOWEVENT = 0x200, /**< Window state change */
SDL_SYSWMEVENT, /**< System specific event */
/* Keyboard events */
SDL_KEYDOWN = 0x300, /**< Keys pressed */
68
SDL_KEYUP, /**< Keys released */
69
SDL_TEXTEDITING, /**< Keyboard text editing (composition) */
70
SDL_TEXTINPUT, /**< Keyboard text input */
71
72
73
/* Mouse events */
SDL_MOUSEMOTION = 0x400, /**< Mouse moved */
74
75
SDL_MOUSEBUTTONDOWN, /**< Mouse button pressed */
SDL_MOUSEBUTTONUP, /**< Mouse button released */
76
SDL_MOUSEWHEEL, /**< Mouse wheel motion */
77
78
79
80
81
82
83
/* Tablet events */
SDL_PROXIMITYIN = 0x500, /**< Proximity In event */
SDL_PROXIMITYOUT, /**< Proximity Out event */
/* Joystick events */
SDL_JOYAXISMOTION = 0x600, /**< Joystick axis motion */
84
85
86
87
SDL_JOYBALLMOTION, /**< Joystick trackball motion */
SDL_JOYHATMOTION, /**< Joystick hat position change */
SDL_JOYBUTTONDOWN, /**< Joystick button pressed */
SDL_JOYBUTTONUP, /**< Joystick button released */
88
89
90
91
92
93
94
95
96
97
98
/* Obsolete events */
SDL_EVENT_COMPAT1 = 0x7000, /**< SDL 1.2 events for compatibility */
SDL_EVENT_COMPAT2,
SDL_EVENT_COMPAT3,
/** Events ::SDL_USEREVENT through ::SDL_LASTEVENT are for your use,
* and should be allocated with SDL_RegisterEvents()
*/
SDL_USEREVENT = 0x8000,
99
100
/**
* This last event is only for bounding internal arrays
101
*/
102
SDL_LASTEVENT = 0xFFFF
103
} SDL_EventType;
104
105
/**
106
* \brief Window state change event data (event.window.*)
107
108
109
*/
typedef struct SDL_WindowEvent
{
110
111
112
113
114
115
116
117
Uint32 type; /**< ::SDL_WINDOWEVENT */
Uint32 windowID; /**< The associated window */
Uint8 event; /**< ::SDL_WindowEventID */
Uint8 padding1;
Uint8 padding2;
Uint8 padding3;
int data1; /**< event dependent data */
int data2; /**< event dependent data */
118
119
120
} SDL_WindowEvent;
/**
121
* \brief Keyboard button event structure (event.key.*)
122
123
124
*/
typedef struct SDL_KeyboardEvent
{
125
126
127
128
129
130
131
Uint32 type; /**< ::SDL_KEYDOWN or ::SDL_KEYUP */
Uint32 windowID; /**< The window with keyboard focus, if any */
Uint8 which; /**< The keyboard device index */
Uint8 state; /**< ::SDL_PRESSED or ::SDL_RELEASED */
Uint8 padding1;
Uint8 padding2;
SDL_keysym keysym; /**< The key that was pressed or released */
132
133
} SDL_KeyboardEvent;
134
#define SDL_TEXTEDITINGEVENT_TEXT_SIZE (32)
135
/**
136
* \brief Keyboard text editing event structure (event.edit.*)
137
138
139
*/
typedef struct SDL_TextEditingEvent
{
140
Uint32 type; /**< ::SDL_TEXTEDITING */
141
142
143
144
145
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;
146
147
#define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
148
/**
149
* \brief Keyboard text input event structure (event.text.*)
150
151
152
*/
typedef struct SDL_TextInputEvent
{
153
Uint32 type; /**< ::SDL_TEXTINPUT */
154
Uint32 windowID; /**< The window with keyboard focus, if any */
155
Uint8 which; /**< The keyboard device index */
156
157
158
Uint8 padding1;
Uint8 padding2;
Uint8 padding3;
159
char text[SDL_TEXTINPUTEVENT_TEXT_SIZE]; /**< The input text */
160
161
162
} SDL_TextInputEvent;
/**
163
* \brief Mouse motion event structure (event.motion.*)
164
165
166
*/
typedef struct SDL_MouseMotionEvent
{
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
Uint32 type; /**< ::SDL_MOUSEMOTION */
Uint32 windowID; /**< The window with mouse focus, if any */
Uint8 which; /**< The mouse device index */
Uint8 state; /**< The current button state */
Uint8 padding1;
Uint8 padding2;
int x; /**< X coordinate, relative to window */
int y; /**< Y coordinate, relative to window */
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_x; /**< For future use */
int tilt_y; /**< For future use */
int cursor; /**< The cursor being used in the event */
int xrel; /**< The relative motion in the X direction */
int yrel; /**< The relative motion in the Y direction */
185
186
} SDL_MouseMotionEvent;
187
/**
188
* \brief Mouse button event structure (event.button.*)
189
190
191
*/
typedef struct SDL_MouseButtonEvent
{
192
193
194
195
196
197
198
199
Uint32 type; /**< ::SDL_MOUSEBUTTONDOWN or ::SDL_MOUSEBUTTONUP */
Uint32 windowID; /**< The window with mouse focus, if any */
Uint8 which; /**< The mouse device index */
Uint8 button; /**< The mouse button index */
Uint8 state; /**< ::SDL_PRESSED or ::SDL_RELEASED */
Uint8 padding1;
int x; /**< X coordinate, relative to window */
int y; /**< Y coordinate, relative to window */
200
201
} SDL_MouseButtonEvent;
202
/**
203
* \brief Mouse wheel event structure (event.wheel.*)
204
205
206
*/
typedef struct SDL_MouseWheelEvent
{
207
208
209
210
211
212
213
214
Uint32 type; /**< ::SDL_MOUSEWHEEL */
Uint32 windowID; /**< The window with mouse focus, if any */
Uint8 which; /**< The mouse device index */
Uint8 padding1;
Uint8 padding2;
Uint8 padding3;
int x; /**< The amount scrolled horizontally */
int y; /**< The amount scrolled vertically */
215
216
} SDL_MouseWheelEvent;
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/**
* \brief Tablet pen proximity event
*/
typedef struct SDL_ProximityEvent
{
Uint32 type; /**< ::SDL_PROXIMITYIN or ::SDL_PROXIMITYOUT */
Uint32 windowID; /**< The associated window */
Uint8 which;
Uint8 padding1;
Uint8 padding2;
Uint8 padding3;
int cursor;
int x;
int y;
} SDL_ProximityEvent;
233
/**
234
* \brief Joystick axis motion event structure (event.jaxis.*)
235
236
237
*/
typedef struct SDL_JoyAxisEvent
{
238
Uint32 type; /**< ::SDL_JOYAXISMOTION */
239
240
Uint8 which; /**< The joystick device index */
Uint8 axis; /**< The joystick axis index */
241
242
Uint8 padding1;
Uint8 padding2;
243
int value; /**< The axis value (range: -32768 to 32767) */
244
245
} SDL_JoyAxisEvent;
246
/**
247
* \brief Joystick trackball motion event structure (event.jball.*)
248
249
250
*/
typedef struct SDL_JoyBallEvent
{
251
Uint32 type; /**< ::SDL_JOYBALLMOTION */
252
253
Uint8 which; /**< The joystick device index */
Uint8 ball; /**< The joystick trackball index */
254
255
Uint8 padding1;
Uint8 padding2;
256
257
int xrel; /**< The relative motion in the X direction */
int yrel; /**< The relative motion in the Y direction */
258
259
} SDL_JoyBallEvent;
260
/**
261
* \brief Joystick hat position change event structure (event.jhat.*)
262
263
264
*/
typedef struct SDL_JoyHatEvent
{
265
Uint32 type; /**< ::SDL_JOYHATMOTION */
266
267
Uint8 which; /**< The joystick device index */
Uint8 hat; /**< The joystick hat index */
268
269
270
271
272
273
Uint8 value; /**< The hat position value.
* \sa ::SDL_HAT_LEFTUP ::SDL_HAT_UP ::SDL_HAT_RIGHTUP
* \sa ::SDL_HAT_LEFT ::SDL_HAT_CENTERED ::SDL_HAT_RIGHT
* \sa ::SDL_HAT_LEFTDOWN ::SDL_HAT_DOWN ::SDL_HAT_RIGHTDOWN
*
* Note that zero means the POV is centered.
274
*/
275
Uint8 padding1;
276
277
} SDL_JoyHatEvent;
278
/**
279
* \brief Joystick button event structure (event.jbutton.*)
280
281
282
*/
typedef struct SDL_JoyButtonEvent
{
283
Uint32 type; /**< ::SDL_JOYBUTTONDOWN or ::SDL_JOYBUTTONUP */
284
285
Uint8 which; /**< The joystick device index */
Uint8 button; /**< The joystick button index */
286
Uint8 state; /**< ::SDL_PRESSED or ::SDL_RELEASED */
287
Uint8 padding1;
288
289
} SDL_JoyButtonEvent;
290
/**
291
* \brief The "quit requested" event
292
*/
293
294
typedef struct SDL_QuitEvent
{
295
Uint32 type; /**< ::SDL_QUIT */
296
297
} SDL_QuitEvent;
298
/**
299
* \brief A user-defined event type (event.user.*)
300
301
302
*/
typedef struct SDL_UserEvent
{
303
304
305
306
307
Uint32 type; /**< ::SDL_USEREVENT through ::SDL_NUMEVENTS-1 */
Uint32 windowID; /**< The associated window if any */
int code; /**< User defined event code */
void *data1; /**< User defined data pointer */
void *data2; /**< User defined data pointer */
308
309
310
311
} SDL_UserEvent;
struct SDL_SysWMmsg;
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
312
313
314
315
316
317
/**
* \brief A video driver dependent system event (event.syswm.*)
*
* \note If you want to use this event, you should include SDL_syswm.h.
*/
318
319
typedef struct SDL_SysWMEvent
{
320
Uint32 type; /**< ::SDL_SYSWMEVENT */
321
SDL_SysWMmsg *msg; /**< driver dependent data, defined in SDL_syswm.h */
322
323
} SDL_SysWMEvent;
324
#ifndef SDL_NO_COMPAT
325
326
327
328
329
330
331
332
333
/**
* \addtogroup Compatibility
*/
/*@{*/
/**
* \name Typedefs for backwards compatibility
*/
/*@{*/
334
335
typedef struct SDL_ActiveEvent
{
336
Uint32 type;
337
338
339
Uint8 gain;
Uint8 state;
} SDL_ActiveEvent;
340
341
342
typedef struct SDL_ResizeEvent
{
343
Uint32 type;
344
345
346
int w;
int h;
} SDL_ResizeEvent;
347
348
349
/*@}*/
/*@}*//*Compatibility*/
350
#endif
351
352
/**
353
* \brief General event structure
354
355
356
*/
typedef union SDL_Event
{
357
Uint32 type; /**< Event type, shared with all events */
358
359
SDL_WindowEvent window; /**< Window event data */
SDL_KeyboardEvent key; /**< Keyboard event data */
360
SDL_TextEditingEvent edit; /**< Text editing event data */
361
SDL_TextInputEvent text; /**< Text input event data */
362
363
SDL_MouseMotionEvent motion; /**< Mouse motion event data */
SDL_MouseButtonEvent button; /**< Mouse button event data */
364
SDL_MouseWheelEvent wheel; /**< Mouse wheel event data */
365
366
367
368
369
370
371
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 */
372
SDL_ProximityEvent proximity; /**< Proximity In or Out event */
373
374
375
/** Temporarily here for backwards compatibility */
/*@{*/
376
#ifndef SDL_NO_COMPAT
377
378
SDL_ActiveEvent active;
SDL_ResizeEvent resize;
379
#endif
380
/*@}*/
381
382
383
384
385
} SDL_Event;
/* Function prototypes */
386
387
388
389
390
391
392
/**
* 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.
*/
393
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
394
395
/*@{*/
396
397
398
399
400
typedef enum
{
SDL_ADDEVENT,
SDL_PEEKEVENT,
SDL_GETEVENT
401
} SDL_eventaction;
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
/**
* Checks the event queue for messages and optionally returns them.
*
* If \c action is ::SDL_ADDEVENT, up to \c numevents events will be added to
* the back of the event queue.
*
* If \c action is ::SDL_PEEKEVENT, up to \c numevents events at the front
* of the event queue, matching \c mask, will be returned and will not
* be removed from the queue.
*
* If \c action is ::SDL_GETEVENT, up to \c numevents events at the front
* of the event queue, matching \c mask, will be returned and will be
* removed from the queue.
*
* \return The number of events actually stored, or -1 if there was an error.
*
* This function is thread-safe.
*/
421
422
extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
SDL_eventaction action,
423
Uint32 minType, Uint32 maxType);
424
/*@}*/
425
426
427
/**
* Checks to see if certain event types are in the event queue.
428
*/
429
430
431
432
433
434
435
436
extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 type);
extern DECLSPEC SDL_bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType);
/**
* This function clears events from the event queue
*/
extern DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type);
extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
437
438
439
440
441
442
443
444
/**
* \brief Polls for currently pending events.
*
* \return 1 if there are any pending events, or 0 if there are none available.
*
* \param event If not NULL, the next event is removed from the queue and
* stored in that area.
445
*/
446
extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
447
448
449
450
451
452
453
454
/**
* \brief Waits indefinitely for the next available event.
*
* \return 1, or 0 if there was an error while waiting for events.
*
* \param event If not NULL, the next event is removed from the queue and
* stored in that area.
455
*/
456
extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
457
458
459
460
461
462
463
464
465
/**
* \brief Waits until the specified timeout (in milliseconds) for the next
* available event.
*
* \return 1, or 0 if there was an error while waiting for events.
*
* \param event If not NULL, the next event is removed from the queue and
* stored in that area.
466
467
468
469
*/
extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
int timeout);
470
471
472
473
474
/**
* \brief Add an event to the event queue.
*
* \return 1 on success, 0 if the event was filtered, or -1 if the event queue
* was full or there was some other error.
475
*/
476
extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
477
478
typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
/**
* 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:
* \code
* int SDL_EventFilter(void *userdata, SDL_Event * event);
* \endcode
*
* 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.
*/
505
506
extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
void *userdata);
507
508
509
510
511
/**
* Return the current event filter - can be used to "chain" filters.
* If there is no event filter set, this function returns SDL_FALSE.
*/
512
513
514
extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
void **userdata);
515
516
517
518
/**
* Run the filter function on the current event queue, removing any
* events for which the filter returns 0.
*/
519
520
extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter,
void *userdata);
521
522
/*@{*/
523
524
525
526
527
#define SDL_QUERY -1
#define SDL_IGNORE 0
#define SDL_DISABLE 0
#define SDL_ENABLE 1
528
529
530
531
532
533
534
535
536
/**
* This function allows you to set the state of processing certain events.
* - If \c state is set to ::SDL_IGNORE, that event will be automatically
* dropped from the event queue and will not event be filtered.
* - If \c state is set to ::SDL_ENABLE, that event will be processed
* normally.
* - If \c state is set to ::SDL_QUERY, SDL_EventState() will return the
* current processing state of the specified event.
*/
537
extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint32 type, int state);
538
/*@}*/
539
540
541
542
543
544
545
546
547
548
#define SDL_GetEventState(type) SDL_EventState(type, SDL_QUERY)
/**
* This function allocates a set of user-defined events, and returns
* the beginning event number for that set of events.
*
* If there aren't enough user-defined events left, this function
* returns (Uint32)-1
*/
extern DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
549
550
551
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
552
/* *INDENT-OFF* */
553
}
554
/* *INDENT-ON* */
555
556
557
558
#endif
#include "close_code.h"
#endif /* _SDL_events_h */
559
560
/* vi: set ts=4 sw=4 expandtab: */