include/SDL_events.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 03 Mar 2013 01:01:33 -0800
changeset 6951 7833f01322b3
parent 6950 1ddb72193079
child 6964 c8aa24f05042
permissions -rw-r--r--
Updated touch API
* Normalized touch coordinates as floats in the 0...1 range
* Removed unused touchpad concepts from the API
* Added API functions to get active touch devices and current finger state
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
slouken@0
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@0
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@0
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@0
    20
*/
slouken@0
    21
slouken@1895
    22
/**
slouken@3407
    23
 *  \file SDL_events.h
slouken@3407
    24
 *  
slouken@3407
    25
 *  Include file for SDL event handling.
slouken@1895
    26
 */
slouken@0
    27
slouken@0
    28
#ifndef _SDL_events_h
slouken@0
    29
#define _SDL_events_h
slouken@0
    30
slouken@1356
    31
#include "SDL_stdinc.h"
slouken@1358
    32
#include "SDL_error.h"
slouken@1895
    33
#include "SDL_video.h"
slouken@0
    34
#include "SDL_keyboard.h"
slouken@0
    35
#include "SDL_mouse.h"
slouken@0
    36
#include "SDL_joystick.h"
slouken@6690
    37
#include "SDL_gamecontroller.h"
slouken@0
    38
#include "SDL_quit.h"
jim@4659
    39
#include "SDL_gesture.h"
jim@4659
    40
#include "SDL_touch.h"
slouken@0
    41
slouken@0
    42
#include "begin_code.h"
slouken@0
    43
/* Set up for C function definitions, even when using C++ */
slouken@0
    44
#ifdef __cplusplus
slouken@1895
    45
/* *INDENT-OFF* */
slouken@0
    46
extern "C" {
slouken@1895
    47
/* *INDENT-ON* */
slouken@0
    48
#endif
slouken@0
    49
slouken@1330
    50
/* General keyboard/mouse state definitions */
slouken@1330
    51
#define SDL_RELEASED	0
slouken@1330
    52
#define SDL_PRESSED	1
slouken@1330
    53
slouken@1895
    54
/**
slouken@3407
    55
 * \brief The types of events that can be delivered.
slouken@1895
    56
 */
slouken@1895
    57
typedef enum
slouken@1895
    58
{
slouken@4429
    59
    SDL_FIRSTEVENT     = 0,     /**< Unused (do not remove) */
slouken@4429
    60
slouken@4429
    61
    /* Application events */
slouken@4429
    62
    SDL_QUIT           = 0x100, /**< User-requested quit */
slouken@4429
    63
slouken@4429
    64
    /* Window events */
slouken@4429
    65
    SDL_WINDOWEVENT    = 0x200, /**< Window state change */
slouken@4429
    66
    SDL_SYSWMEVENT,             /**< System specific event */
slouken@4429
    67
slouken@4429
    68
    /* Keyboard events */
slouken@4971
    69
    SDL_KEYDOWN        = 0x300, /**< Key pressed */
slouken@4971
    70
    SDL_KEYUP,                  /**< Key released */
slouken@3280
    71
    SDL_TEXTEDITING,            /**< Keyboard text editing (composition) */
slouken@1957
    72
    SDL_TEXTINPUT,              /**< Keyboard text input */
slouken@4429
    73
slouken@4429
    74
    /* Mouse events */
slouken@4429
    75
    SDL_MOUSEMOTION    = 0x400, /**< Mouse moved */
slouken@1895
    76
    SDL_MOUSEBUTTONDOWN,        /**< Mouse button pressed */
slouken@1895
    77
    SDL_MOUSEBUTTONUP,          /**< Mouse button released */
slouken@1957
    78
    SDL_MOUSEWHEEL,             /**< Mouse wheel motion */
slouken@4429
    79
slouken@4465
    80
    /* Tablet or multiple mice input device events */
slouken@4465
    81
    SDL_INPUTMOTION    = 0x500, /**< Input moved */
slouken@4465
    82
    SDL_INPUTBUTTONDOWN,        /**< Input button pressed */
slouken@4465
    83
    SDL_INPUTBUTTONUP,          /**< Input button released */
slouken@4465
    84
    SDL_INPUTWHEEL,             /**< Input wheel motion */
slouken@4465
    85
    SDL_INPUTPROXIMITYIN,       /**< Input pen entered proximity */
slouken@4465
    86
    SDL_INPUTPROXIMITYOUT,      /**< Input pen left proximity */
slouken@4429
    87
slouken@4429
    88
    /* Joystick events */
slouken@4429
    89
    SDL_JOYAXISMOTION  = 0x600, /**< Joystick axis motion */
slouken@1895
    90
    SDL_JOYBALLMOTION,          /**< Joystick trackball motion */
slouken@1895
    91
    SDL_JOYHATMOTION,           /**< Joystick hat position change */
slouken@1895
    92
    SDL_JOYBUTTONDOWN,          /**< Joystick button pressed */
slouken@1895
    93
    SDL_JOYBUTTONUP,            /**< Joystick button released */
slouken@6690
    94
    SDL_JOYDEVICEADDED,         /**< A new joystick has been inserted into the system */
slouken@6690
    95
    SDL_JOYDEVICEREMOVED,       /**< An opened joystick has been removed */
slouken@6690
    96
slouken@6690
    97
	/* Game controller events */
slouken@6690
    98
	SDL_CONTROLLERAXISMOTION  = 0x650, /**< Game controller axis motion */
slouken@6690
    99
	SDL_CONTROLLERBUTTONDOWN,          /**< Game controller button pressed */
slouken@6690
   100
	SDL_CONTROLLERBUTTONUP,            /**< Game controller button released */
slouken@6690
   101
	SDL_CONTROLLERDEVICEADDED,         /**< A new Game controller has been inserted into the system */
slouken@6690
   102
	SDL_CONTROLLERDEVICEREMOVED,       /**< An opened Game controller has been removed */
slouken@4429
   103
slouken@4661
   104
    /* Touch events */
slouken@4661
   105
    SDL_FINGERDOWN      = 0x700,
jim@4641
   106
    SDL_FINGERUP,
jim@4641
   107
    SDL_FINGERMOTION,
jim@4641
   108
slouken@4661
   109
    /* Gesture events */
slouken@4661
   110
    SDL_DOLLARGESTURE   = 0x800,
jim@4659
   111
    SDL_DOLLARRECORD,
jim@4657
   112
    SDL_MULTIGESTURE,
jim@4657
   113
slouken@4503
   114
    /* Clipboard events */
slouken@6091
   115
    SDL_CLIPBOARDUPDATE = 0x900, /**< The clipboard changed */
jim@4662
   116
slouken@6091
   117
    /* Drag and drop events */
slouken@6091
   118
    SDL_DROPFILE        = 0x1000, /**< The system requests a file open */
slouken@4503
   119
slouken@4429
   120
    /** Events ::SDL_USEREVENT through ::SDL_LASTEVENT are for your use,
slouken@4429
   121
     *  and should be allocated with SDL_RegisterEvents()
slouken@4429
   122
     */
slouken@4429
   123
    SDL_USEREVENT    = 0x8000,
slouken@4429
   124
slouken@3407
   125
    /**
slouken@3407
   126
     *  This last event is only for bounding internal arrays
slouken@1895
   127
     */
slouken@4429
   128
    SDL_LASTEVENT    = 0xFFFF
slouken@1294
   129
} SDL_EventType;
slouken@0
   130
slouken@1895
   131
/**
slouken@6949
   132
 *  \brief Fields shared by every event
slouken@6949
   133
 */
slouken@6949
   134
typedef struct SDL_GenericEvent
slouken@6949
   135
{
slouken@6949
   136
    Uint32 type;
slouken@6949
   137
    Uint32 timestamp;
slouken@6949
   138
} SDL_GenericEvent;
slouken@6949
   139
    
slouken@6949
   140
/**
slouken@3407
   141
 *  \brief Window state change event data (event.window.*)
slouken@1895
   142
 */
slouken@1895
   143
typedef struct SDL_WindowEvent
slouken@1895
   144
{
slouken@4429
   145
    Uint32 type;        /**< ::SDL_WINDOWEVENT */
slouken@6114
   146
    Uint32 timestamp;
slouken@4429
   147
    Uint32 windowID;    /**< The associated window */
slouken@4429
   148
    Uint8 event;        /**< ::SDL_WindowEventID */
slouken@4429
   149
    Uint8 padding1;
slouken@4429
   150
    Uint8 padding2;
slouken@4429
   151
    Uint8 padding3;
slouken@6950
   152
    Sint32 data1;       /**< event dependent data */
slouken@6950
   153
    Sint32 data2;       /**< event dependent data */
slouken@1895
   154
} SDL_WindowEvent;
slouken@0
   155
slouken@1895
   156
/**
slouken@3407
   157
 *  \brief Keyboard button event structure (event.key.*)
slouken@1895
   158
 */
slouken@1895
   159
typedef struct SDL_KeyboardEvent
slouken@1895
   160
{
slouken@4429
   161
    Uint32 type;        /**< ::SDL_KEYDOWN or ::SDL_KEYUP */
slouken@6114
   162
    Uint32 timestamp;
slouken@4429
   163
    Uint32 windowID;    /**< The window with keyboard focus, if any */
slouken@4429
   164
    Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
slouken@4560
   165
    Uint8 repeat;       /**< Non-zero if this is a key repeat */
slouken@4429
   166
    Uint8 padding2;
slouken@4465
   167
    Uint8 padding3;
slouken@5218
   168
    SDL_Keysym keysym;  /**< The key that was pressed or released */
slouken@0
   169
} SDL_KeyboardEvent;
slouken@0
   170
slouken@3407
   171
#define SDL_TEXTEDITINGEVENT_TEXT_SIZE (32)
slouken@1895
   172
/**
slouken@3407
   173
 *  \brief Keyboard text editing event structure (event.edit.*)
slouken@3280
   174
 */
slouken@3280
   175
typedef struct SDL_TextEditingEvent
slouken@3280
   176
{
slouken@4429
   177
    Uint32 type;                                /**< ::SDL_TEXTEDITING */
slouken@6114
   178
    Uint32 timestamp;
slouken@4434
   179
    Uint32 windowID;                            /**< The window with keyboard focus, if any */
slouken@3280
   180
    char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE];  /**< The editing text */
slouken@6950
   181
    Sint32 start;                               /**< The start cursor of selected editing text */
slouken@6950
   182
    Sint32 length;                              /**< The length of selected editing text */
slouken@3280
   183
} SDL_TextEditingEvent;
slouken@3280
   184
slouken@3407
   185
slouken@3407
   186
#define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
slouken@3280
   187
/**
slouken@3407
   188
 *  \brief Keyboard text input event structure (event.text.*)
slouken@1895
   189
 */
slouken@1895
   190
typedef struct SDL_TextInputEvent
slouken@1895
   191
{
slouken@4429
   192
    Uint32 type;                              /**< ::SDL_TEXTINPUT */
slouken@6114
   193
    Uint32 timestamp;
slouken@3685
   194
    Uint32 windowID;                          /**< The window with keyboard focus, if any */
bob@2300
   195
    char text[SDL_TEXTINPUTEVENT_TEXT_SIZE];  /**< The input text */
slouken@1895
   196
} SDL_TextInputEvent;
slouken@1895
   197
slouken@1895
   198
/**
slouken@3407
   199
 *  \brief Mouse motion event structure (event.motion.*)
slouken@1895
   200
 */
slouken@1895
   201
typedef struct SDL_MouseMotionEvent
slouken@1895
   202
{
slouken@4429
   203
    Uint32 type;        /**< ::SDL_MOUSEMOTION */
slouken@6114
   204
    Uint32 timestamp;
slouken@4429
   205
    Uint32 windowID;    /**< The window with mouse focus, if any */
slouken@6950
   206
    Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
slouken@4429
   207
    Uint8 state;        /**< The current button state */
slouken@4429
   208
    Uint8 padding1;
slouken@4429
   209
    Uint8 padding2;
slouken@4465
   210
    Uint8 padding3;
slouken@6950
   211
    Sint32 x;           /**< X coordinate, relative to window */
slouken@6950
   212
    Sint32 y;           /**< Y coordinate, relative to window */
slouken@6950
   213
    Sint32 xrel;        /**< The relative motion in the X direction */
slouken@6950
   214
    Sint32 yrel;        /**< The relative motion in the Y direction */
slouken@0
   215
} SDL_MouseMotionEvent;
slouken@0
   216
slouken@1895
   217
/**
slouken@3407
   218
 *  \brief Mouse button event structure (event.button.*)
slouken@1895
   219
 */
slouken@1895
   220
typedef struct SDL_MouseButtonEvent
slouken@1895
   221
{
slouken@4429
   222
    Uint32 type;        /**< ::SDL_MOUSEBUTTONDOWN or ::SDL_MOUSEBUTTONUP */
slouken@6114
   223
    Uint32 timestamp;
slouken@4429
   224
    Uint32 windowID;    /**< The window with mouse focus, if any */
slouken@6950
   225
    Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
slouken@4429
   226
    Uint8 button;       /**< The mouse button index */
slouken@4429
   227
    Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
slouken@4429
   228
    Uint8 padding1;
slouken@4465
   229
    Uint8 padding2;
slouken@6950
   230
    Sint32 x;           /**< X coordinate, relative to window */
slouken@6950
   231
    Sint32 y;           /**< Y coordinate, relative to window */
slouken@0
   232
} SDL_MouseButtonEvent;
slouken@0
   233
slouken@1895
   234
/**
slouken@3407
   235
 *  \brief Mouse wheel event structure (event.wheel.*)
slouken@1895
   236
 */
slouken@1895
   237
typedef struct SDL_MouseWheelEvent
slouken@1895
   238
{
slouken@4429
   239
    Uint32 type;        /**< ::SDL_MOUSEWHEEL */
slouken@6114
   240
    Uint32 timestamp;
slouken@4429
   241
    Uint32 windowID;    /**< The window with mouse focus, if any */
slouken@6950
   242
    Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
slouken@6950
   243
    Sint32 x;           /**< The amount scrolled horizontally */
slouken@6950
   244
    Sint32 y;           /**< The amount scrolled vertically */
slouken@1895
   245
} SDL_MouseWheelEvent;
slouken@1895
   246
slouken@1895
   247
/**
slouken@3407
   248
 *  \brief Joystick axis motion event structure (event.jaxis.*)
slouken@1895
   249
 */
slouken@1895
   250
typedef struct SDL_JoyAxisEvent
slouken@1895
   251
{
slouken@4429
   252
    Uint32 type;        /**< ::SDL_JOYAXISMOTION */
slouken@6114
   253
    Uint32 timestamp;
slouken@6949
   254
    Uint32 which;       /**< The joystick instance id */
slouken@1895
   255
    Uint8 axis;         /**< The joystick axis index */
slouken@4429
   256
    Uint8 padding1;
slouken@4429
   257
    Uint8 padding2;
slouken@6949
   258
    Uint8 padding3;
slouken@6949
   259
    Sint16 value;       /**< The axis value (range: -32768 to 32767) */
slouken@6949
   260
    Uint16 padding4;
slouken@0
   261
} SDL_JoyAxisEvent;
slouken@0
   262
slouken@1895
   263
/**
slouken@3407
   264
 *  \brief Joystick trackball motion event structure (event.jball.*)
slouken@1895
   265
 */
slouken@1895
   266
typedef struct SDL_JoyBallEvent
slouken@1895
   267
{
slouken@4429
   268
    Uint32 type;        /**< ::SDL_JOYBALLMOTION */
slouken@6114
   269
    Uint32 timestamp;
slouken@6949
   270
    Uint32 which;       /**< The joystick instance id */
slouken@1895
   271
    Uint8 ball;         /**< The joystick trackball index */
slouken@4429
   272
    Uint8 padding1;
slouken@4429
   273
    Uint8 padding2;
slouken@6949
   274
    Uint8 padding3;
slouken@6949
   275
    Sint16 xrel;        /**< The relative motion in the X direction */
slouken@6949
   276
    Sint16 yrel;        /**< The relative motion in the Y direction */
slouken@0
   277
} SDL_JoyBallEvent;
slouken@0
   278
slouken@1895
   279
/**
slouken@3407
   280
 *  \brief Joystick hat position change event structure (event.jhat.*)
slouken@1895
   281
 */
slouken@1895
   282
typedef struct SDL_JoyHatEvent
slouken@1895
   283
{
slouken@4429
   284
    Uint32 type;        /**< ::SDL_JOYHATMOTION */
slouken@6114
   285
    Uint32 timestamp;
slouken@6949
   286
    Uint32 which;       /**< The joystick instance id */
slouken@1895
   287
    Uint8 hat;          /**< The joystick hat index */
slouken@3407
   288
    Uint8 value;        /**< The hat position value.
slouken@3407
   289
                         *   \sa ::SDL_HAT_LEFTUP ::SDL_HAT_UP ::SDL_HAT_RIGHTUP
slouken@3407
   290
                         *   \sa ::SDL_HAT_LEFT ::SDL_HAT_CENTERED ::SDL_HAT_RIGHT
slouken@3407
   291
                         *   \sa ::SDL_HAT_LEFTDOWN ::SDL_HAT_DOWN ::SDL_HAT_RIGHTDOWN
slouken@3407
   292
                         *   
slouken@3407
   293
                         *   Note that zero means the POV is centered.
slouken@1895
   294
                         */
slouken@4429
   295
    Uint8 padding1;
slouken@6949
   296
    Uint8 padding2;
slouken@0
   297
} SDL_JoyHatEvent;
slouken@0
   298
slouken@1895
   299
/**
slouken@3407
   300
 *  \brief Joystick button event structure (event.jbutton.*)
slouken@1895
   301
 */
slouken@1895
   302
typedef struct SDL_JoyButtonEvent
slouken@1895
   303
{
slouken@4429
   304
    Uint32 type;        /**< ::SDL_JOYBUTTONDOWN or ::SDL_JOYBUTTONUP */
slouken@6114
   305
    Uint32 timestamp;
slouken@6949
   306
    Uint32 which;       /**< The joystick instance id */
slouken@1895
   307
    Uint8 button;       /**< The joystick button index */
slouken@3407
   308
    Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
slouken@4429
   309
    Uint8 padding1;
slouken@6949
   310
    Uint8 padding2;
slouken@0
   311
} SDL_JoyButtonEvent;
slouken@0
   312
slouken@6690
   313
/**
slouken@6690
   314
 *  \brief Joystick device event structure (event.jdevice.*)
slouken@6690
   315
 */
slouken@6690
   316
typedef struct SDL_JoyDeviceEvent
slouken@6690
   317
{
slouken@6690
   318
	Uint32 type;        /**< ::SDL_JOYDEVICEADDED or ::SDL_JOYDEVICEREMOVED */
slouken@6690
   319
	Uint32 timestamp;
slouken@6949
   320
	Uint32 which;       /**< The joystick device index for the ADDED event, instance id for the REMOVED event */
slouken@6690
   321
} SDL_JoyDeviceEvent;
slouken@6690
   322
slouken@6690
   323
slouken@6690
   324
/**
slouken@6690
   325
 *  \brief Game controller axis motion event structure (event.caxis.*)
slouken@6690
   326
 */
slouken@6690
   327
typedef struct SDL_ControllerAxisEvent
slouken@6690
   328
{
slouken@6690
   329
    Uint32 type;        /**< ::SDL_CONTROLLERAXISMOTION */
slouken@6690
   330
    Uint32 timestamp;
slouken@6949
   331
    Uint32 which;       /**< The joystick instance id */
slouken@6949
   332
    Uint8 axis;         /**< The controller axis (SDL_GameControllerAxis) */
slouken@6949
   333
    Uint8 padding1;
slouken@6949
   334
    Uint8 padding2;
slouken@6949
   335
    Uint8 padding3;
slouken@6949
   336
    Sint16 value;       /**< The axis value (range: -32768 to 32767) */
slouken@6949
   337
    Uint16 padding4;
slouken@6690
   338
} SDL_ControllerAxisEvent;
slouken@6690
   339
slouken@6690
   340
slouken@6690
   341
/**
slouken@6690
   342
 *  \brief Game controller button event structure (event.cbutton.*)
slouken@6690
   343
 */
slouken@6690
   344
typedef struct SDL_ControllerButtonEvent
slouken@6690
   345
{
slouken@6690
   346
    Uint32 type;        /**< ::SDL_CONTROLLERBUTTONDOWN or ::SDL_CONTROLLERBUTTONUP */
slouken@6690
   347
    Uint32 timestamp;
slouken@6949
   348
    Uint32 which;       /**< The joystick instance id */
slouken@6949
   349
    Uint8 button;       /**< The controller button (SDL_GameControllerButton) */
slouken@6690
   350
    Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
slouken@6949
   351
    Uint8 padding1;
slouken@6949
   352
    Uint8 padding2;
slouken@6690
   353
} SDL_ControllerButtonEvent;
slouken@6690
   354
slouken@6690
   355
slouken@6690
   356
/**
slouken@6690
   357
 *  \brief Controller device event structure (event.cdevice.*)
slouken@6690
   358
 */
slouken@6690
   359
typedef struct SDL_ControllerDeviceEvent
slouken@6690
   360
{
slouken@6690
   361
	Uint32 type;        /**< ::SDL_CONTROLLERDEVICEADDED or ::SDL_CONTROLLERDEVICEREMOVED */
slouken@6690
   362
	Uint32 timestamp;
slouken@6949
   363
	Uint32 which;       /**< The joystick device index for the ADDED event, instance id for the REMOVED event */
slouken@6690
   364
} SDL_ControllerDeviceEvent;
slouken@6690
   365
jim@4641
   366
jim@4641
   367
/**
slouken@6951
   368
 *  \brief Touch finger event structure (event.tfinger.*)
jim@4641
   369
 */
jim@4641
   370
typedef struct SDL_TouchFingerEvent
jim@4641
   371
{
slouken@6949
   372
    Uint32 type;        /**< ::SDL_FINGERMOTION or ::SDL_FINGERDOWN or ::SDL_FINGERUP */
slouken@6114
   373
    Uint32 timestamp;
slouken@6949
   374
    SDL_TouchID touchId; /**< The touch device id */
jimtla@4678
   375
    SDL_FingerID fingerId;
slouken@6951
   376
    float x;            /**< Normalized in the range 0...1 */
slouken@6951
   377
    float y;            /**< Normalized in the range 0...1 */
slouken@6951
   378
    float dx;           /**< Normalized in the range 0...1 */
slouken@6951
   379
    float dy;           /**< Normalized in the range 0...1 */
slouken@6951
   380
    float pressure;     /**< Normalized in the range 0...1 */
jim@4641
   381
} SDL_TouchFingerEvent;
jim@4641
   382
jim@4641
   383
jim@4641
   384
/**
slouken@5009
   385
 *  \brief Multiple Finger Gesture Event (event.mgesture.*)
jim@4657
   386
 */
jim@4657
   387
typedef struct SDL_MultiGestureEvent
jim@4657
   388
{
jim@4657
   389
    Uint32 type;        /**< ::SDL_MULTIGESTURE */
slouken@6114
   390
    Uint32 timestamp;
slouken@6951
   391
    SDL_TouchID touchId; /**< The touch device index */
jim@4657
   392
    float dTheta;
jim@4657
   393
    float dDist;
slouken@6951
   394
    float x;
jim@4657
   395
    float y;  
jim@4683
   396
    Uint16 numFingers;
jim@4683
   397
    Uint16 padding;
jim@4657
   398
} SDL_MultiGestureEvent;
jim@4657
   399
slouken@6951
   400
slouken@5014
   401
/* (event.dgesture.*) */
slouken@5014
   402
typedef struct SDL_DollarGestureEvent
jim@4658
   403
{
jim@4658
   404
    Uint32 type;        /**< ::SDL_DOLLARGESTURE */
slouken@6114
   405
    Uint32 timestamp;
slouken@6951
   406
    SDL_TouchID touchId; /**< The touch device id */
jimtla@4678
   407
    SDL_GestureID gestureId;
jim@4689
   408
    Uint32 numFingers;
jim@4658
   409
    float error;
slouken@6951
   410
    float x;            /**< Normalized center of gesture */
slouken@6951
   411
    float y;            /**< Normalized center of gesture */
jim@4658
   412
} SDL_DollarGestureEvent;
jim@4658
   413
jim@4657
   414
slouken@1895
   415
/**
slouken@6091
   416
 *  \brief An event used to request a file open by the system (event.drop.*)
slouken@6091
   417
 *         This event is disabled by default, you can enable it with SDL_EventState()
slouken@6091
   418
 *  \note If you enable this event, you must free the filename in the event.
slouken@6091
   419
 */
slouken@6091
   420
typedef struct SDL_DropEvent
slouken@6091
   421
{
slouken@6091
   422
    Uint32 type;        /**< ::SDL_DROPFILE */
slouken@6114
   423
    Uint32 timestamp;
slouken@6091
   424
    char *file;         /**< The file name, which should be freed with SDL_free() */
slouken@6091
   425
} SDL_DropEvent;
slouken@6091
   426
slouken@6091
   427
slouken@6091
   428
/**
slouken@3407
   429
 *  \brief The "quit requested" event
slouken@0
   430
 */
slouken@1895
   431
typedef struct SDL_QuitEvent
slouken@1895
   432
{
slouken@4429
   433
    Uint32 type;        /**< ::SDL_QUIT */
slouken@6114
   434
    Uint32 timestamp;
slouken@1895
   435
} SDL_QuitEvent;
slouken@1895
   436
slouken@5009
   437
slouken@1895
   438
/**
slouken@3407
   439
 *  \brief A user-defined event type (event.user.*)
slouken@1895
   440
 */
slouken@1895
   441
typedef struct SDL_UserEvent
slouken@1895
   442
{
slouken@4429
   443
    Uint32 type;        /**< ::SDL_USEREVENT through ::SDL_NUMEVENTS-1 */
slouken@6114
   444
    Uint32 timestamp;
slouken@4429
   445
    Uint32 windowID;    /**< The associated window if any */
slouken@6950
   446
    Sint32 code;        /**< User defined event code */
slouken@4429
   447
    void *data1;        /**< User defined data pointer */
slouken@4429
   448
    void *data2;        /**< User defined data pointer */
slouken@1895
   449
} SDL_UserEvent;
slouken@1895
   450
slouken@5009
   451
slouken@1895
   452
struct SDL_SysWMmsg;
slouken@1895
   453
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
slouken@3407
   454
slouken@3407
   455
/**
slouken@3407
   456
 *  \brief A video driver dependent system event (event.syswm.*)
slouken@6091
   457
 *         This event is disabled by default, you can enable it with SDL_EventState()
slouken@6091
   458
 *
slouken@3407
   459
 *  \note If you want to use this event, you should include SDL_syswm.h.
slouken@3407
   460
 */
slouken@1895
   461
typedef struct SDL_SysWMEvent
slouken@1895
   462
{
slouken@4429
   463
    Uint32 type;        /**< ::SDL_SYSWMEVENT */
slouken@6114
   464
    Uint32 timestamp;
slouken@1895
   465
    SDL_SysWMmsg *msg;  /**< driver dependent data, defined in SDL_syswm.h */
slouken@1895
   466
} SDL_SysWMEvent;
slouken@1895
   467
slouken@1895
   468
/**
slouken@3407
   469
 *  \brief General event structure
slouken@1895
   470
 */
slouken@1895
   471
typedef union SDL_Event
slouken@1895
   472
{
slouken@4429
   473
    Uint32 type;                    /**< Event type, shared with all events */
slouken@6949
   474
    SDL_GenericEvent generic;       /**< Generic event data */
slouken@1895
   475
    SDL_WindowEvent window;         /**< Window event data */
slouken@1895
   476
    SDL_KeyboardEvent key;          /**< Keyboard event data */
slouken@3280
   477
    SDL_TextEditingEvent edit;      /**< Text editing event data */
bob@2300
   478
    SDL_TextInputEvent text;        /**< Text input event data */
slouken@1895
   479
    SDL_MouseMotionEvent motion;    /**< Mouse motion event data */
slouken@1895
   480
    SDL_MouseButtonEvent button;    /**< Mouse button event data */
bob@2300
   481
    SDL_MouseWheelEvent wheel;      /**< Mouse wheel event data */
slouken@1895
   482
    SDL_JoyAxisEvent jaxis;         /**< Joystick axis event data */
slouken@1895
   483
    SDL_JoyBallEvent jball;         /**< Joystick ball event data */
slouken@1895
   484
    SDL_JoyHatEvent jhat;           /**< Joystick hat event data */
slouken@1895
   485
    SDL_JoyButtonEvent jbutton;     /**< Joystick button event data */
slouken@6690
   486
    SDL_JoyDeviceEvent jdevice;     /**< Joystick device change event data */
slouken@6690
   487
	SDL_ControllerAxisEvent caxis;		/**< Game Controller button event data */
slouken@6690
   488
	SDL_ControllerButtonEvent cbutton;  /**< Game Controller button event data */
slouken@6690
   489
	SDL_ControllerDeviceEvent cdevice;  /**< Game Controller device event data */
slouken@1895
   490
    SDL_QuitEvent quit;             /**< Quit request event data */
slouken@1895
   491
    SDL_UserEvent user;             /**< Custom event data */
slouken@1895
   492
    SDL_SysWMEvent syswm;           /**< System dependent window event data */
jim@4641
   493
    SDL_TouchFingerEvent tfinger;   /**< Touch finger event data */
slouken@6951
   494
    SDL_MultiGestureEvent mgesture; /**< Gesture event data */
slouken@6951
   495
    SDL_DollarGestureEvent dgesture; /**< Gesture event data */
slouken@6091
   496
    SDL_DropEvent drop;             /**< Drag and drop event data */
slouken@6595
   497
slouken@6595
   498
    /* This is necessary for ABI compatibility between Visual C++ and GCC
slouken@6595
   499
       Visual C++ will respect the push pack pragma and use 52 bytes for
slouken@6595
   500
       this structure, and GCC will use the alignment of the largest datatype
slouken@6595
   501
       within the union, which is 8 bytes.
slouken@6595
   502
slouken@6595
   503
       So... we'll add padding to force the size to be 56 bytes for both.
slouken@6595
   504
    */
slouken@6595
   505
    Uint8 padding[56];
slouken@0
   506
} SDL_Event;
slouken@0
   507
slouken@0
   508
slouken@0
   509
/* Function prototypes */
slouken@0
   510
slouken@3407
   511
/**
slouken@3407
   512
 *  Pumps the event loop, gathering events from the input devices.
slouken@3407
   513
 *  
slouken@3407
   514
 *  This function updates the event queue and internal input device state.
slouken@3407
   515
 *  
slouken@3407
   516
 *  This should only be run in the thread that sets the video mode.
slouken@3407
   517
 */
slouken@337
   518
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
slouken@0
   519
slouken@3407
   520
/*@{*/
slouken@1895
   521
typedef enum
slouken@1895
   522
{
slouken@1895
   523
    SDL_ADDEVENT,
slouken@1895
   524
    SDL_PEEKEVENT,
slouken@1895
   525
    SDL_GETEVENT
slouken@0
   526
} SDL_eventaction;
slouken@3407
   527
slouken@3407
   528
/**
slouken@3407
   529
 *  Checks the event queue for messages and optionally returns them.
slouken@3407
   530
 *  
slouken@3407
   531
 *  If \c action is ::SDL_ADDEVENT, up to \c numevents events will be added to
slouken@3407
   532
 *  the back of the event queue.
slouken@3407
   533
 *  
slouken@3407
   534
 *  If \c action is ::SDL_PEEKEVENT, up to \c numevents events at the front
slouken@4635
   535
 *  of the event queue, within the specified minimum and maximum type,
slouken@4635
   536
 *  will be returned and will not be removed from the queue.
slouken@3407
   537
 *  
slouken@3407
   538
 *  If \c action is ::SDL_GETEVENT, up to \c numevents events at the front 
slouken@4635
   539
 *  of the event queue, within the specified minimum and maximum type,
slouken@4635
   540
 *  will be returned and will be removed from the queue.
slouken@3407
   541
 *  
slouken@3407
   542
 *  \return The number of events actually stored, or -1 if there was an error.
slouken@3407
   543
 *  
slouken@3407
   544
 *  This function is thread-safe.
slouken@3407
   545
 */
slouken@1895
   546
extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
slouken@1895
   547
                                           SDL_eventaction action,
slouken@4429
   548
                                           Uint32 minType, Uint32 maxType);
slouken@3407
   549
/*@}*/
slouken@1895
   550
slouken@3407
   551
/**
slouken@3407
   552
 *  Checks to see if certain event types are in the event queue.
slouken@1895
   553
 */
slouken@4429
   554
extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 type);
slouken@4429
   555
extern DECLSPEC SDL_bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType);
slouken@4429
   556
slouken@4429
   557
/**
slouken@4429
   558
 *  This function clears events from the event queue
slouken@4429
   559
 */
slouken@4429
   560
extern DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type);
slouken@4429
   561
extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
slouken@0
   562
slouken@3407
   563
/**
slouken@3407
   564
 *  \brief Polls for currently pending events.
slouken@3407
   565
 *  
slouken@3407
   566
 *  \return 1 if there are any pending events, or 0 if there are none available.
slouken@3407
   567
 *  
slouken@3407
   568
 *  \param event If not NULL, the next event is removed from the queue and 
slouken@3407
   569
 *               stored in that area.
slouken@0
   570
 */
slouken@1895
   571
extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
slouken@0
   572
slouken@3407
   573
/**
slouken@3407
   574
 *  \brief Waits indefinitely for the next available event.
slouken@3407
   575
 *  
slouken@3407
   576
 *  \return 1, or 0 if there was an error while waiting for events.
slouken@3407
   577
 *   
slouken@3407
   578
 *  \param event If not NULL, the next event is removed from the queue and 
slouken@3407
   579
 *               stored in that area.
slouken@0
   580
 */
slouken@1895
   581
extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
slouken@0
   582
slouken@3407
   583
/**
slouken@3407
   584
 *  \brief Waits until the specified timeout (in milliseconds) for the next 
slouken@3407
   585
 *         available event.
slouken@3407
   586
 *  
slouken@3407
   587
 *  \return 1, or 0 if there was an error while waiting for events.
slouken@3407
   588
 *  
slouken@3407
   589
 *  \param event If not NULL, the next event is removed from the queue and 
slouken@3407
   590
 *               stored in that area.
slouken@3072
   591
 */
slouken@3072
   592
extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
slouken@3072
   593
                                                 int timeout);
slouken@3072
   594
slouken@3407
   595
/**
slouken@3407
   596
 *  \brief Add an event to the event queue.
slouken@3407
   597
 *  
slouken@3407
   598
 *  \return 1 on success, 0 if the event was filtered, or -1 if the event queue 
slouken@3407
   599
 *          was full or there was some other error.
slouken@0
   600
 */
slouken@1895
   601
extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
slouken@0
   602
slouken@3407
   603
typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
slouken@0
   604
slouken@3407
   605
/**
slouken@3407
   606
 *  Sets up a filter to process all events before they change internal state and
slouken@3407
   607
 *  are posted to the internal event queue.
slouken@3407
   608
 *  
slouken@3407
   609
 *  The filter is protypted as:
slouken@3407
   610
 *  \code
slouken@3407
   611
 *      int SDL_EventFilter(void *userdata, SDL_Event * event);
slouken@3407
   612
 *  \endcode
slouken@3407
   613
 *
slouken@3407
   614
 *  If the filter returns 1, then the event will be added to the internal queue.
slouken@3407
   615
 *  If it returns 0, then the event will be dropped from the queue, but the 
slouken@3407
   616
 *  internal state will still be updated.  This allows selective filtering of
slouken@3407
   617
 *  dynamically arriving events.
slouken@3407
   618
 *  
slouken@3407
   619
 *  \warning  Be very careful of what you do in the event filter function, as 
slouken@3407
   620
 *            it may run in a different thread!
slouken@3407
   621
 *  
slouken@3407
   622
 *  There is one caveat when dealing with the ::SDL_QUITEVENT event type.  The
slouken@3407
   623
 *  event filter is only called when the window manager desires to close the
slouken@3407
   624
 *  application window.  If the event filter returns 1, then the window will
slouken@3407
   625
 *  be closed, otherwise the window will remain open if possible.
slouken@3407
   626
 *
slouken@3407
   627
 *  If the quit event is generated by an interrupt signal, it will bypass the
slouken@3407
   628
 *  internal queue and be delivered to the application at the next event poll.
slouken@3407
   629
 */
slouken@1895
   630
extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
slouken@1895
   631
                                                void *userdata);
slouken@0
   632
slouken@3407
   633
/**
slouken@3407
   634
 *  Return the current event filter - can be used to "chain" filters.
slouken@3407
   635
 *  If there is no event filter set, this function returns SDL_FALSE.
slouken@3407
   636
 */
slouken@1895
   637
extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
slouken@1895
   638
                                                    void **userdata);
slouken@1895
   639
slouken@3407
   640
/**
slouken@5146
   641
 *  Add a function which is called when an event is added to the queue.
slouken@5146
   642
 */
slouken@5146
   643
extern DECLSPEC void SDLCALL SDL_AddEventWatch(SDL_EventFilter filter,
slouken@5146
   644
                                               void *userdata);
slouken@5146
   645
slouken@5146
   646
/**
slouken@5146
   647
 *  Remove an event watch function added with SDL_AddEventWatch()
slouken@5146
   648
 */
slouken@5146
   649
extern DECLSPEC void SDLCALL SDL_DelEventWatch(SDL_EventFilter filter,
slouken@5146
   650
                                               void *userdata);
slouken@5146
   651
slouken@5146
   652
/**
slouken@3407
   653
 *  Run the filter function on the current event queue, removing any
slouken@3407
   654
 *  events for which the filter returns 0.
slouken@3407
   655
 */
slouken@1895
   656
extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter,
slouken@1895
   657
                                              void *userdata);
slouken@0
   658
slouken@3407
   659
/*@{*/
slouken@0
   660
#define SDL_QUERY	-1
slouken@0
   661
#define SDL_IGNORE	 0
slouken@0
   662
#define SDL_DISABLE	 0
slouken@0
   663
#define SDL_ENABLE	 1
slouken@3407
   664
slouken@3407
   665
/**
slouken@3407
   666
 *  This function allows you to set the state of processing certain events.
slouken@3407
   667
 *   - If \c state is set to ::SDL_IGNORE, that event will be automatically 
slouken@3407
   668
 *     dropped from the event queue and will not event be filtered.
slouken@3407
   669
 *   - If \c state is set to ::SDL_ENABLE, that event will be processed 
slouken@3407
   670
 *     normally.
slouken@3407
   671
 *   - If \c state is set to ::SDL_QUERY, SDL_EventState() will return the 
slouken@3407
   672
 *     current processing state of the specified event.
slouken@3407
   673
 */
slouken@4429
   674
extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint32 type, int state);
slouken@3407
   675
/*@}*/
slouken@4429
   676
#define SDL_GetEventState(type) SDL_EventState(type, SDL_QUERY)
slouken@4429
   677
slouken@4429
   678
/**
slouken@4429
   679
 *  This function allocates a set of user-defined events, and returns
slouken@4429
   680
 *  the beginning event number for that set of events.
slouken@4429
   681
 *
slouken@4429
   682
 *  If there aren't enough user-defined events left, this function
slouken@4429
   683
 *  returns (Uint32)-1
slouken@4429
   684
 */
slouken@4429
   685
extern DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
slouken@0
   686
slouken@0
   687
/* Ends C function definitions when using C++ */
slouken@0
   688
#ifdef __cplusplus
slouken@1895
   689
/* *INDENT-OFF* */
slouken@0
   690
}
slouken@1895
   691
/* *INDENT-ON* */
slouken@0
   692
#endif
slouken@0
   693
#include "close_code.h"
slouken@0
   694
slouken@0
   695
#endif /* _SDL_events_h */
slouken@1895
   696
slouken@1895
   697
/* vi: set ts=4 sw=4 expandtab: */