include/SDL_events.h
author Sam Lantinga <slouken@libsdl.org>
Tue, 27 Oct 2015 11:17:32 -0700
changeset 9898 0da384bef562
parent 9825 dfdb0933d57c
child 9998 f67cf37e9cd4
permissions -rw-r--r--
Add a new SDL_KEYMAPCHANGED SDL event to abstract notification of keyboard layout or input language changes.
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@9619
     3
  Copyright (C) 1997-2015 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@7191
    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@0
    45
extern "C" {
slouken@0
    46
#endif
slouken@0
    47
slouken@1330
    48
/* General keyboard/mouse state definitions */
slouken@7191
    49
#define SDL_RELEASED    0
slouken@7191
    50
#define SDL_PRESSED 1
slouken@1330
    51
slouken@1895
    52
/**
slouken@3407
    53
 * \brief The types of events that can be delivered.
slouken@1895
    54
 */
slouken@1895
    55
typedef enum
slouken@1895
    56
{
slouken@4429
    57
    SDL_FIRSTEVENT     = 0,     /**< Unused (do not remove) */
slouken@4429
    58
slouken@4429
    59
    /* Application events */
slouken@4429
    60
    SDL_QUIT           = 0x100, /**< User-requested quit */
slouken@4429
    61
philipp@9049
    62
    /* These application events have special meaning on iOS, see README-ios.md for details */
slouken@7191
    63
    SDL_APP_TERMINATING,        /**< The application is being terminated by the OS
slouken@7190
    64
                                     Called on iOS in applicationWillTerminate()
slouken@7190
    65
                                     Called on Android in onDestroy()
slouken@7190
    66
                                */
slouken@7191
    67
    SDL_APP_LOWMEMORY,          /**< The application is low on memory, free memory if possible.
slouken@7190
    68
                                     Called on iOS in applicationDidReceiveMemoryWarning()
slouken@7190
    69
                                     Called on Android in onLowMemory()
slouken@7190
    70
                                */
slouken@7191
    71
    SDL_APP_WILLENTERBACKGROUND, /**< The application is about to enter the background
slouken@7190
    72
                                     Called on iOS in applicationWillResignActive()
slouken@7190
    73
                                     Called on Android in onPause()
slouken@7190
    74
                                */
slouken@7191
    75
    SDL_APP_DIDENTERBACKGROUND, /**< The application did enter the background and may not get CPU for some time
slouken@7190
    76
                                     Called on iOS in applicationDidEnterBackground()
slouken@7190
    77
                                     Called on Android in onPause()
slouken@7190
    78
                                */
slouken@7191
    79
    SDL_APP_WILLENTERFOREGROUND, /**< The application is about to enter the foreground
slouken@7190
    80
                                     Called on iOS in applicationWillEnterForeground()
slouken@7190
    81
                                     Called on Android in onResume()
slouken@7190
    82
                                */
slouken@7191
    83
    SDL_APP_DIDENTERFOREGROUND, /**< The application is now interactive
slouken@7190
    84
                                     Called on iOS in applicationDidBecomeActive()
slouken@7190
    85
                                     Called on Android in onResume()
slouken@7190
    86
                                */
slouken@7190
    87
slouken@4429
    88
    /* Window events */
slouken@4429
    89
    SDL_WINDOWEVENT    = 0x200, /**< Window state change */
slouken@4429
    90
    SDL_SYSWMEVENT,             /**< System specific event */
slouken@4429
    91
slouken@4429
    92
    /* Keyboard events */
slouken@4971
    93
    SDL_KEYDOWN        = 0x300, /**< Key pressed */
slouken@4971
    94
    SDL_KEYUP,                  /**< Key released */
slouken@3280
    95
    SDL_TEXTEDITING,            /**< Keyboard text editing (composition) */
slouken@1957
    96
    SDL_TEXTINPUT,              /**< Keyboard text input */
slouken@9898
    97
    SDL_KEYMAPCHANGED,          /**< Keymap changed due to a system event such as an
slouken@9898
    98
                                     input language or keyboard layout change.
slouken@9898
    99
                                */
slouken@4429
   100
slouken@4429
   101
    /* Mouse events */
slouken@4429
   102
    SDL_MOUSEMOTION    = 0x400, /**< Mouse moved */
slouken@1895
   103
    SDL_MOUSEBUTTONDOWN,        /**< Mouse button pressed */
slouken@1895
   104
    SDL_MOUSEBUTTONUP,          /**< Mouse button released */
slouken@1957
   105
    SDL_MOUSEWHEEL,             /**< Mouse wheel motion */
slouken@4429
   106
slouken@4429
   107
    /* Joystick events */
slouken@4429
   108
    SDL_JOYAXISMOTION  = 0x600, /**< Joystick axis motion */
slouken@1895
   109
    SDL_JOYBALLMOTION,          /**< Joystick trackball motion */
slouken@1895
   110
    SDL_JOYHATMOTION,           /**< Joystick hat position change */
slouken@1895
   111
    SDL_JOYBUTTONDOWN,          /**< Joystick button pressed */
slouken@1895
   112
    SDL_JOYBUTTONUP,            /**< Joystick button released */
slouken@6690
   113
    SDL_JOYDEVICEADDED,         /**< A new joystick has been inserted into the system */
slouken@6690
   114
    SDL_JOYDEVICEREMOVED,       /**< An opened joystick has been removed */
slouken@6690
   115
slouken@7191
   116
    /* Game controller events */
slouken@7191
   117
    SDL_CONTROLLERAXISMOTION  = 0x650, /**< Game controller axis motion */
slouken@7191
   118
    SDL_CONTROLLERBUTTONDOWN,          /**< Game controller button pressed */
slouken@7191
   119
    SDL_CONTROLLERBUTTONUP,            /**< Game controller button released */
slouken@7191
   120
    SDL_CONTROLLERDEVICEADDED,         /**< A new Game controller has been inserted into the system */
slouken@7191
   121
    SDL_CONTROLLERDEVICEREMOVED,       /**< An opened Game controller has been removed */
slouken@7191
   122
    SDL_CONTROLLERDEVICEREMAPPED,      /**< The controller mapping was updated */
slouken@4429
   123
slouken@4661
   124
    /* Touch events */
slouken@4661
   125
    SDL_FINGERDOWN      = 0x700,
jim@4641
   126
    SDL_FINGERUP,
jim@4641
   127
    SDL_FINGERMOTION,
jim@4641
   128
slouken@4661
   129
    /* Gesture events */
slouken@4661
   130
    SDL_DOLLARGESTURE   = 0x800,
jim@4659
   131
    SDL_DOLLARRECORD,
jim@4657
   132
    SDL_MULTIGESTURE,
jim@4657
   133
slouken@4503
   134
    /* Clipboard events */
slouken@6091
   135
    SDL_CLIPBOARDUPDATE = 0x900, /**< The clipboard changed */
jim@4662
   136
slouken@6091
   137
    /* Drag and drop events */
slouken@6091
   138
    SDL_DROPFILE        = 0x1000, /**< The system requests a file open */
slouken@7191
   139
philipp@9417
   140
    /* Audio hotplug events */
philipp@9417
   141
    SDL_AUDIODEVICEADDED = 0x1100, /**< A new audio device is available */
philipp@9417
   142
    SDL_AUDIODEVICEREMOVED,        /**< An audio device has been removed. */
philipp@9417
   143
slouken@8207
   144
    /* Render events */
slouken@8674
   145
    SDL_RENDER_TARGETS_RESET = 0x2000, /**< The render targets have been reset and their contents need to be updated */
slouken@8674
   146
    SDL_RENDER_DEVICE_RESET, /**< The device has been reset and all textures need to be recreated */
slouken@8207
   147
slouken@4429
   148
    /** Events ::SDL_USEREVENT through ::SDL_LASTEVENT are for your use,
slouken@4429
   149
     *  and should be allocated with SDL_RegisterEvents()
slouken@4429
   150
     */
slouken@4429
   151
    SDL_USEREVENT    = 0x8000,
slouken@4429
   152
slouken@3407
   153
    /**
slouken@3407
   154
     *  This last event is only for bounding internal arrays
slouken@1895
   155
     */
slouken@4429
   156
    SDL_LASTEVENT    = 0xFFFF
slouken@1294
   157
} SDL_EventType;
slouken@0
   158
slouken@1895
   159
/**
slouken@6949
   160
 *  \brief Fields shared by every event
slouken@6949
   161
 */
dludwig@7082
   162
typedef struct SDL_CommonEvent
slouken@6949
   163
{
slouken@6949
   164
    Uint32 type;
slouken@6949
   165
    Uint32 timestamp;
dludwig@7082
   166
} SDL_CommonEvent;
slouken@7191
   167
slouken@6949
   168
/**
slouken@3407
   169
 *  \brief Window state change event data (event.window.*)
slouken@1895
   170
 */
slouken@1895
   171
typedef struct SDL_WindowEvent
slouken@1895
   172
{
slouken@4429
   173
    Uint32 type;        /**< ::SDL_WINDOWEVENT */
slouken@6114
   174
    Uint32 timestamp;
slouken@4429
   175
    Uint32 windowID;    /**< The associated window */
slouken@4429
   176
    Uint8 event;        /**< ::SDL_WindowEventID */
slouken@4429
   177
    Uint8 padding1;
slouken@4429
   178
    Uint8 padding2;
slouken@4429
   179
    Uint8 padding3;
slouken@6950
   180
    Sint32 data1;       /**< event dependent data */
slouken@6950
   181
    Sint32 data2;       /**< event dependent data */
slouken@1895
   182
} SDL_WindowEvent;
slouken@0
   183
slouken@1895
   184
/**
slouken@3407
   185
 *  \brief Keyboard button event structure (event.key.*)
slouken@1895
   186
 */
slouken@1895
   187
typedef struct SDL_KeyboardEvent
slouken@1895
   188
{
slouken@4429
   189
    Uint32 type;        /**< ::SDL_KEYDOWN or ::SDL_KEYUP */
slouken@6114
   190
    Uint32 timestamp;
slouken@4429
   191
    Uint32 windowID;    /**< The window with keyboard focus, if any */
slouken@4429
   192
    Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
slouken@4560
   193
    Uint8 repeat;       /**< Non-zero if this is a key repeat */
slouken@4429
   194
    Uint8 padding2;
slouken@4465
   195
    Uint8 padding3;
slouken@5218
   196
    SDL_Keysym keysym;  /**< The key that was pressed or released */
slouken@0
   197
} SDL_KeyboardEvent;
slouken@0
   198
slouken@3407
   199
#define SDL_TEXTEDITINGEVENT_TEXT_SIZE (32)
slouken@1895
   200
/**
slouken@3407
   201
 *  \brief Keyboard text editing event structure (event.edit.*)
slouken@3280
   202
 */
slouken@3280
   203
typedef struct SDL_TextEditingEvent
slouken@3280
   204
{
slouken@4429
   205
    Uint32 type;                                /**< ::SDL_TEXTEDITING */
slouken@6114
   206
    Uint32 timestamp;
slouken@4434
   207
    Uint32 windowID;                            /**< The window with keyboard focus, if any */
slouken@3280
   208
    char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE];  /**< The editing text */
slouken@6950
   209
    Sint32 start;                               /**< The start cursor of selected editing text */
slouken@6950
   210
    Sint32 length;                              /**< The length of selected editing text */
slouken@3280
   211
} SDL_TextEditingEvent;
slouken@3280
   212
slouken@3407
   213
slouken@3407
   214
#define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
slouken@3280
   215
/**
slouken@3407
   216
 *  \brief Keyboard text input event structure (event.text.*)
slouken@1895
   217
 */
slouken@1895
   218
typedef struct SDL_TextInputEvent
slouken@1895
   219
{
slouken@4429
   220
    Uint32 type;                              /**< ::SDL_TEXTINPUT */
slouken@6114
   221
    Uint32 timestamp;
slouken@3685
   222
    Uint32 windowID;                          /**< The window with keyboard focus, if any */
bob@2300
   223
    char text[SDL_TEXTINPUTEVENT_TEXT_SIZE];  /**< The input text */
slouken@1895
   224
} SDL_TextInputEvent;
slouken@1895
   225
slouken@1895
   226
/**
slouken@3407
   227
 *  \brief Mouse motion event structure (event.motion.*)
slouken@1895
   228
 */
slouken@1895
   229
typedef struct SDL_MouseMotionEvent
slouken@1895
   230
{
slouken@4429
   231
    Uint32 type;        /**< ::SDL_MOUSEMOTION */
slouken@6114
   232
    Uint32 timestamp;
slouken@4429
   233
    Uint32 windowID;    /**< The window with mouse focus, if any */
slouken@6950
   234
    Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
slouken@7203
   235
    Uint32 state;       /**< The current button state */
slouken@6950
   236
    Sint32 x;           /**< X coordinate, relative to window */
slouken@6950
   237
    Sint32 y;           /**< Y coordinate, relative to window */
slouken@6950
   238
    Sint32 xrel;        /**< The relative motion in the X direction */
slouken@6950
   239
    Sint32 yrel;        /**< The relative motion in the Y direction */
slouken@0
   240
} SDL_MouseMotionEvent;
slouken@0
   241
slouken@1895
   242
/**
slouken@3407
   243
 *  \brief Mouse button event structure (event.button.*)
slouken@1895
   244
 */
slouken@1895
   245
typedef struct SDL_MouseButtonEvent
slouken@1895
   246
{
slouken@4429
   247
    Uint32 type;        /**< ::SDL_MOUSEBUTTONDOWN or ::SDL_MOUSEBUTTONUP */
slouken@6114
   248
    Uint32 timestamp;
slouken@4429
   249
    Uint32 windowID;    /**< The window with mouse focus, if any */
slouken@6950
   250
    Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
slouken@4429
   251
    Uint8 button;       /**< The mouse button index */
slouken@4429
   252
    Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
slouken@8066
   253
    Uint8 clicks;       /**< 1 for single-click, 2 for double-click, etc. */
slouken@4429
   254
    Uint8 padding1;
slouken@6950
   255
    Sint32 x;           /**< X coordinate, relative to window */
slouken@6950
   256
    Sint32 y;           /**< Y coordinate, relative to window */
slouken@0
   257
} SDL_MouseButtonEvent;
slouken@0
   258
slouken@1895
   259
/**
slouken@3407
   260
 *  \brief Mouse wheel event structure (event.wheel.*)
slouken@1895
   261
 */
slouken@1895
   262
typedef struct SDL_MouseWheelEvent
slouken@1895
   263
{
slouken@4429
   264
    Uint32 type;        /**< ::SDL_MOUSEWHEEL */
slouken@6114
   265
    Uint32 timestamp;
slouken@4429
   266
    Uint32 windowID;    /**< The window with mouse focus, if any */
slouken@6950
   267
    Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
slouken@8232
   268
    Sint32 x;           /**< The amount scrolled horizontally, positive to the right and negative to the left */
slouken@8232
   269
    Sint32 y;           /**< The amount scrolled vertically, positive away from the user and negative toward the user */
urkle@9257
   270
    Uint32 direction;   /**< Set to one of the SDL_MOUSEWHEEL_* defines. When FLIPPED the values in X and Y will be opposite. Multiply by -1 to change them back */
slouken@1895
   271
} SDL_MouseWheelEvent;
slouken@1895
   272
slouken@1895
   273
/**
slouken@3407
   274
 *  \brief Joystick axis motion event structure (event.jaxis.*)
slouken@1895
   275
 */
slouken@1895
   276
typedef struct SDL_JoyAxisEvent
slouken@1895
   277
{
slouken@4429
   278
    Uint32 type;        /**< ::SDL_JOYAXISMOTION */
slouken@6114
   279
    Uint32 timestamp;
slouken@6974
   280
    SDL_JoystickID which; /**< The joystick instance id */
slouken@1895
   281
    Uint8 axis;         /**< The joystick axis index */
slouken@4429
   282
    Uint8 padding1;
slouken@4429
   283
    Uint8 padding2;
slouken@6949
   284
    Uint8 padding3;
slouken@6949
   285
    Sint16 value;       /**< The axis value (range: -32768 to 32767) */
slouken@6949
   286
    Uint16 padding4;
slouken@0
   287
} SDL_JoyAxisEvent;
slouken@0
   288
slouken@1895
   289
/**
slouken@3407
   290
 *  \brief Joystick trackball motion event structure (event.jball.*)
slouken@1895
   291
 */
slouken@1895
   292
typedef struct SDL_JoyBallEvent
slouken@1895
   293
{
slouken@4429
   294
    Uint32 type;        /**< ::SDL_JOYBALLMOTION */
slouken@7191
   295
    Uint32 timestamp;
slouken@6974
   296
    SDL_JoystickID which; /**< The joystick instance id */
slouken@1895
   297
    Uint8 ball;         /**< The joystick trackball index */
slouken@4429
   298
    Uint8 padding1;
slouken@4429
   299
    Uint8 padding2;
slouken@6949
   300
    Uint8 padding3;
slouken@6949
   301
    Sint16 xrel;        /**< The relative motion in the X direction */
slouken@6949
   302
    Sint16 yrel;        /**< The relative motion in the Y direction */
slouken@0
   303
} SDL_JoyBallEvent;
slouken@0
   304
slouken@1895
   305
/**
slouken@3407
   306
 *  \brief Joystick hat position change event structure (event.jhat.*)
slouken@1895
   307
 */
slouken@1895
   308
typedef struct SDL_JoyHatEvent
slouken@1895
   309
{
slouken@4429
   310
    Uint32 type;        /**< ::SDL_JOYHATMOTION */
slouken@7191
   311
    Uint32 timestamp;
slouken@6974
   312
    SDL_JoystickID which; /**< The joystick instance id */
slouken@1895
   313
    Uint8 hat;          /**< The joystick hat index */
slouken@3407
   314
    Uint8 value;        /**< The hat position value.
slouken@3407
   315
                         *   \sa ::SDL_HAT_LEFTUP ::SDL_HAT_UP ::SDL_HAT_RIGHTUP
slouken@3407
   316
                         *   \sa ::SDL_HAT_LEFT ::SDL_HAT_CENTERED ::SDL_HAT_RIGHT
slouken@3407
   317
                         *   \sa ::SDL_HAT_LEFTDOWN ::SDL_HAT_DOWN ::SDL_HAT_RIGHTDOWN
slouken@7191
   318
                         *
slouken@3407
   319
                         *   Note that zero means the POV is centered.
slouken@1895
   320
                         */
slouken@4429
   321
    Uint8 padding1;
slouken@6949
   322
    Uint8 padding2;
slouken@0
   323
} SDL_JoyHatEvent;
slouken@0
   324
slouken@1895
   325
/**
slouken@3407
   326
 *  \brief Joystick button event structure (event.jbutton.*)
slouken@1895
   327
 */
slouken@1895
   328
typedef struct SDL_JoyButtonEvent
slouken@1895
   329
{
slouken@4429
   330
    Uint32 type;        /**< ::SDL_JOYBUTTONDOWN or ::SDL_JOYBUTTONUP */
slouken@7191
   331
    Uint32 timestamp;
slouken@6974
   332
    SDL_JoystickID which; /**< The joystick instance id */
slouken@1895
   333
    Uint8 button;       /**< The joystick button index */
slouken@3407
   334
    Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
slouken@4429
   335
    Uint8 padding1;
slouken@6949
   336
    Uint8 padding2;
slouken@0
   337
} SDL_JoyButtonEvent;
slouken@0
   338
slouken@6690
   339
/**
slouken@6690
   340
 *  \brief Joystick device event structure (event.jdevice.*)
slouken@6690
   341
 */
slouken@6690
   342
typedef struct SDL_JoyDeviceEvent
slouken@6690
   343
{
slouken@7191
   344
    Uint32 type;        /**< ::SDL_JOYDEVICEADDED or ::SDL_JOYDEVICEREMOVED */
slouken@7191
   345
    Uint32 timestamp;
slouken@7191
   346
    Sint32 which;       /**< The joystick device index for the ADDED event, instance id for the REMOVED event */
slouken@6690
   347
} SDL_JoyDeviceEvent;
slouken@6690
   348
slouken@6690
   349
slouken@6690
   350
/**
slouken@6690
   351
 *  \brief Game controller axis motion event structure (event.caxis.*)
slouken@6690
   352
 */
slouken@6690
   353
typedef struct SDL_ControllerAxisEvent
slouken@6690
   354
{
slouken@6690
   355
    Uint32 type;        /**< ::SDL_CONTROLLERAXISMOTION */
slouken@7191
   356
    Uint32 timestamp;
slouken@6974
   357
    SDL_JoystickID which; /**< The joystick instance id */
slouken@6949
   358
    Uint8 axis;         /**< The controller axis (SDL_GameControllerAxis) */
slouken@6949
   359
    Uint8 padding1;
slouken@6949
   360
    Uint8 padding2;
slouken@6949
   361
    Uint8 padding3;
slouken@6949
   362
    Sint16 value;       /**< The axis value (range: -32768 to 32767) */
slouken@6949
   363
    Uint16 padding4;
slouken@6690
   364
} SDL_ControllerAxisEvent;
slouken@6690
   365
slouken@6690
   366
slouken@6690
   367
/**
slouken@6690
   368
 *  \brief Game controller button event structure (event.cbutton.*)
slouken@6690
   369
 */
slouken@6690
   370
typedef struct SDL_ControllerButtonEvent
slouken@6690
   371
{
slouken@6690
   372
    Uint32 type;        /**< ::SDL_CONTROLLERBUTTONDOWN or ::SDL_CONTROLLERBUTTONUP */
slouken@7191
   373
    Uint32 timestamp;
slouken@6974
   374
    SDL_JoystickID which; /**< The joystick instance id */
slouken@6949
   375
    Uint8 button;       /**< The controller button (SDL_GameControllerButton) */
slouken@6690
   376
    Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
slouken@6949
   377
    Uint8 padding1;
slouken@6949
   378
    Uint8 padding2;
slouken@6690
   379
} SDL_ControllerButtonEvent;
slouken@6690
   380
slouken@6690
   381
slouken@6690
   382
/**
slouken@6690
   383
 *  \brief Controller device event structure (event.cdevice.*)
slouken@6690
   384
 */
slouken@6690
   385
typedef struct SDL_ControllerDeviceEvent
slouken@6690
   386
{
slouken@7191
   387
    Uint32 type;        /**< ::SDL_CONTROLLERDEVICEADDED, ::SDL_CONTROLLERDEVICEREMOVED, or ::SDL_CONTROLLERDEVICEREMAPPED */
slouken@7191
   388
    Uint32 timestamp;
slouken@7191
   389
    Sint32 which;       /**< The joystick device index for the ADDED event, instance id for the REMOVED or REMAPPED event */
slouken@6690
   390
} SDL_ControllerDeviceEvent;
slouken@6690
   391
icculus@9393
   392
/**
icculus@9393
   393
 *  \brief Audio device event structure (event.adevice.*)
icculus@9393
   394
 */
icculus@9393
   395
typedef struct SDL_AudioDeviceEvent
icculus@9393
   396
{
icculus@9393
   397
    Uint32 type;        /**< ::SDL_AUDIODEVICEADDED, or ::SDL_AUDIODEVICEREMOVED */
icculus@9393
   398
    Uint32 timestamp;
icculus@9393
   399
    Uint32 which;       /**< The audio device index for the ADDED event (valid until next SDL_GetNumAudioDevices() call), SDL_AudioDeviceID for the REMOVED event */
icculus@9393
   400
    Uint8 iscapture;    /**< zero if an output device, non-zero if a capture device. */
icculus@9393
   401
    Uint8 padding1;
icculus@9393
   402
    Uint8 padding2;
icculus@9393
   403
    Uint8 padding3;
icculus@9393
   404
} SDL_AudioDeviceEvent;
icculus@9393
   405
jim@4641
   406
jim@4641
   407
/**
slouken@6951
   408
 *  \brief Touch finger event structure (event.tfinger.*)
jim@4641
   409
 */
jim@4641
   410
typedef struct SDL_TouchFingerEvent
jim@4641
   411
{
slouken@6949
   412
    Uint32 type;        /**< ::SDL_FINGERMOTION or ::SDL_FINGERDOWN or ::SDL_FINGERUP */
slouken@6114
   413
    Uint32 timestamp;
slouken@6949
   414
    SDL_TouchID touchId; /**< The touch device id */
jimtla@4678
   415
    SDL_FingerID fingerId;
slouken@6951
   416
    float x;            /**< Normalized in the range 0...1 */
slouken@6951
   417
    float y;            /**< Normalized in the range 0...1 */
philipp@9593
   418
    float dx;           /**< Normalized in the range -1...1 */
philipp@9593
   419
    float dy;           /**< Normalized in the range -1...1 */
slouken@6951
   420
    float pressure;     /**< Normalized in the range 0...1 */
jim@4641
   421
} SDL_TouchFingerEvent;
jim@4641
   422
jim@4641
   423
jim@4641
   424
/**
slouken@5009
   425
 *  \brief Multiple Finger Gesture Event (event.mgesture.*)
jim@4657
   426
 */
jim@4657
   427
typedef struct SDL_MultiGestureEvent
jim@4657
   428
{
jim@4657
   429
    Uint32 type;        /**< ::SDL_MULTIGESTURE */
slouken@6114
   430
    Uint32 timestamp;
slouken@6951
   431
    SDL_TouchID touchId; /**< The touch device index */
jim@4657
   432
    float dTheta;
jim@4657
   433
    float dDist;
slouken@6951
   434
    float x;
slouken@7191
   435
    float y;
jim@4683
   436
    Uint16 numFingers;
jim@4683
   437
    Uint16 padding;
jim@4657
   438
} SDL_MultiGestureEvent;
jim@4657
   439
slouken@6951
   440
philipp@7309
   441
/**
philipp@7309
   442
 * \brief Dollar Gesture Event (event.dgesture.*)
philipp@7309
   443
 */
slouken@5014
   444
typedef struct SDL_DollarGestureEvent
jim@4658
   445
{
philipp@9418
   446
    Uint32 type;        /**< ::SDL_DOLLARGESTURE or ::SDL_DOLLARRECORD */
slouken@6114
   447
    Uint32 timestamp;
slouken@6951
   448
    SDL_TouchID touchId; /**< The touch device id */
jimtla@4678
   449
    SDL_GestureID gestureId;
jim@4689
   450
    Uint32 numFingers;
jim@4658
   451
    float error;
slouken@6951
   452
    float x;            /**< Normalized center of gesture */
slouken@6951
   453
    float y;            /**< Normalized center of gesture */
jim@4658
   454
} SDL_DollarGestureEvent;
jim@4658
   455
jim@4657
   456
slouken@1895
   457
/**
slouken@6091
   458
 *  \brief An event used to request a file open by the system (event.drop.*)
philipp@9825
   459
 *         This event is enabled by default, you can disable it with SDL_EventState().
philipp@9825
   460
 *  \note If this event is enabled, you must free the filename in the event.
slouken@6091
   461
 */
slouken@6091
   462
typedef struct SDL_DropEvent
slouken@6091
   463
{
slouken@6091
   464
    Uint32 type;        /**< ::SDL_DROPFILE */
slouken@6114
   465
    Uint32 timestamp;
slouken@6091
   466
    char *file;         /**< The file name, which should be freed with SDL_free() */
slouken@6091
   467
} SDL_DropEvent;
slouken@6091
   468
slouken@6091
   469
slouken@6091
   470
/**
slouken@3407
   471
 *  \brief The "quit requested" event
slouken@0
   472
 */
slouken@1895
   473
typedef struct SDL_QuitEvent
slouken@1895
   474
{
slouken@4429
   475
    Uint32 type;        /**< ::SDL_QUIT */
slouken@6114
   476
    Uint32 timestamp;
slouken@1895
   477
} SDL_QuitEvent;
slouken@1895
   478
slouken@7190
   479
/**
slouken@7190
   480
 *  \brief OS Specific event
slouken@7190
   481
 */
slouken@7190
   482
typedef struct SDL_OSEvent
slouken@7190
   483
{
slouken@7190
   484
    Uint32 type;        /**< ::SDL_QUIT */
slouken@7190
   485
    Uint32 timestamp;
slouken@7190
   486
} SDL_OSEvent;
slouken@5009
   487
slouken@1895
   488
/**
slouken@3407
   489
 *  \brief A user-defined event type (event.user.*)
slouken@1895
   490
 */
slouken@1895
   491
typedef struct SDL_UserEvent
slouken@1895
   492
{
philipp@7278
   493
    Uint32 type;        /**< ::SDL_USEREVENT through ::SDL_LASTEVENT-1 */
slouken@6114
   494
    Uint32 timestamp;
slouken@4429
   495
    Uint32 windowID;    /**< The associated window if any */
slouken@6950
   496
    Sint32 code;        /**< User defined event code */
slouken@4429
   497
    void *data1;        /**< User defined data pointer */
slouken@4429
   498
    void *data2;        /**< User defined data pointer */
slouken@1895
   499
} SDL_UserEvent;
slouken@1895
   500
slouken@5009
   501
slouken@1895
   502
struct SDL_SysWMmsg;
slouken@1895
   503
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
slouken@3407
   504
slouken@3407
   505
/**
slouken@3407
   506
 *  \brief A video driver dependent system event (event.syswm.*)
slouken@6091
   507
 *         This event is disabled by default, you can enable it with SDL_EventState()
slouken@6091
   508
 *
slouken@3407
   509
 *  \note If you want to use this event, you should include SDL_syswm.h.
slouken@3407
   510
 */
slouken@1895
   511
typedef struct SDL_SysWMEvent
slouken@1895
   512
{
slouken@4429
   513
    Uint32 type;        /**< ::SDL_SYSWMEVENT */
slouken@6114
   514
    Uint32 timestamp;
slouken@1895
   515
    SDL_SysWMmsg *msg;  /**< driver dependent data, defined in SDL_syswm.h */
slouken@1895
   516
} SDL_SysWMEvent;
slouken@1895
   517
slouken@1895
   518
/**
slouken@3407
   519
 *  \brief General event structure
slouken@1895
   520
 */
slouken@1895
   521
typedef union SDL_Event
slouken@1895
   522
{
slouken@4429
   523
    Uint32 type;                    /**< Event type, shared with all events */
dludwig@7082
   524
    SDL_CommonEvent common;         /**< Common event data */
slouken@1895
   525
    SDL_WindowEvent window;         /**< Window event data */
slouken@1895
   526
    SDL_KeyboardEvent key;          /**< Keyboard event data */
slouken@3280
   527
    SDL_TextEditingEvent edit;      /**< Text editing event data */
bob@2300
   528
    SDL_TextInputEvent text;        /**< Text input event data */
slouken@1895
   529
    SDL_MouseMotionEvent motion;    /**< Mouse motion event data */
slouken@1895
   530
    SDL_MouseButtonEvent button;    /**< Mouse button event data */
bob@2300
   531
    SDL_MouseWheelEvent wheel;      /**< Mouse wheel event data */
slouken@1895
   532
    SDL_JoyAxisEvent jaxis;         /**< Joystick axis event data */
slouken@1895
   533
    SDL_JoyBallEvent jball;         /**< Joystick ball event data */
slouken@1895
   534
    SDL_JoyHatEvent jhat;           /**< Joystick hat event data */
slouken@1895
   535
    SDL_JoyButtonEvent jbutton;     /**< Joystick button event data */
slouken@6690
   536
    SDL_JoyDeviceEvent jdevice;     /**< Joystick device change event data */
slouken@7191
   537
    SDL_ControllerAxisEvent caxis;      /**< Game Controller axis event data */
slouken@7191
   538
    SDL_ControllerButtonEvent cbutton;  /**< Game Controller button event data */
slouken@7191
   539
    SDL_ControllerDeviceEvent cdevice;  /**< Game Controller device event data */
icculus@9393
   540
    SDL_AudioDeviceEvent adevice;   /**< Audio device event data */
slouken@1895
   541
    SDL_QuitEvent quit;             /**< Quit request event data */
slouken@1895
   542
    SDL_UserEvent user;             /**< Custom event data */
slouken@1895
   543
    SDL_SysWMEvent syswm;           /**< System dependent window event data */
jim@4641
   544
    SDL_TouchFingerEvent tfinger;   /**< Touch finger event data */
slouken@6951
   545
    SDL_MultiGestureEvent mgesture; /**< Gesture event data */
slouken@6951
   546
    SDL_DollarGestureEvent dgesture; /**< Gesture event data */
slouken@6091
   547
    SDL_DropEvent drop;             /**< Drag and drop event data */
slouken@6595
   548
slouken@6595
   549
    /* This is necessary for ABI compatibility between Visual C++ and GCC
slouken@6595
   550
       Visual C++ will respect the push pack pragma and use 52 bytes for
slouken@6595
   551
       this structure, and GCC will use the alignment of the largest datatype
slouken@6595
   552
       within the union, which is 8 bytes.
slouken@6595
   553
slouken@6595
   554
       So... we'll add padding to force the size to be 56 bytes for both.
slouken@6595
   555
    */
slouken@6595
   556
    Uint8 padding[56];
slouken@0
   557
} SDL_Event;
slouken@0
   558
slouken@0
   559
slouken@0
   560
/* Function prototypes */
slouken@0
   561
slouken@3407
   562
/**
slouken@3407
   563
 *  Pumps the event loop, gathering events from the input devices.
slouken@7191
   564
 *
slouken@3407
   565
 *  This function updates the event queue and internal input device state.
slouken@7191
   566
 *
slouken@3407
   567
 *  This should only be run in the thread that sets the video mode.
slouken@3407
   568
 */
slouken@337
   569
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
slouken@0
   570
gabomdq@7678
   571
/* @{ */
slouken@1895
   572
typedef enum
slouken@1895
   573
{
slouken@1895
   574
    SDL_ADDEVENT,
slouken@1895
   575
    SDL_PEEKEVENT,
slouken@1895
   576
    SDL_GETEVENT
slouken@0
   577
} SDL_eventaction;
slouken@3407
   578
slouken@3407
   579
/**
slouken@3407
   580
 *  Checks the event queue for messages and optionally returns them.
slouken@7191
   581
 *
slouken@3407
   582
 *  If \c action is ::SDL_ADDEVENT, up to \c numevents events will be added to
slouken@3407
   583
 *  the back of the event queue.
slouken@7191
   584
 *
slouken@3407
   585
 *  If \c action is ::SDL_PEEKEVENT, up to \c numevents events at the front
slouken@4635
   586
 *  of the event queue, within the specified minimum and maximum type,
slouken@4635
   587
 *  will be returned and will not be removed from the queue.
slouken@7191
   588
 *
slouken@7191
   589
 *  If \c action is ::SDL_GETEVENT, up to \c numevents events at the front
slouken@4635
   590
 *  of the event queue, within the specified minimum and maximum type,
slouken@4635
   591
 *  will be returned and will be removed from the queue.
slouken@7191
   592
 *
slouken@3407
   593
 *  \return The number of events actually stored, or -1 if there was an error.
slouken@7191
   594
 *
slouken@3407
   595
 *  This function is thread-safe.
slouken@3407
   596
 */
slouken@1895
   597
extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
slouken@1895
   598
                                           SDL_eventaction action,
slouken@4429
   599
                                           Uint32 minType, Uint32 maxType);
gabomdq@7678
   600
/* @} */
slouken@1895
   601
slouken@3407
   602
/**
slouken@3407
   603
 *  Checks to see if certain event types are in the event queue.
slouken@1895
   604
 */
slouken@4429
   605
extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 type);
slouken@4429
   606
extern DECLSPEC SDL_bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType);
slouken@4429
   607
slouken@4429
   608
/**
slouken@4429
   609
 *  This function clears events from the event queue
slouken@9002
   610
 *  This function only affects currently queued events. If you want to make
slouken@9002
   611
 *  sure that all pending OS events are flushed, you can call SDL_PumpEvents()
slouken@9002
   612
 *  on the main thread immediately before the flush call.
slouken@4429
   613
 */
slouken@4429
   614
extern DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type);
slouken@4429
   615
extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
slouken@0
   616
slouken@3407
   617
/**
slouken@3407
   618
 *  \brief Polls for currently pending events.
slouken@7191
   619
 *
slouken@3407
   620
 *  \return 1 if there are any pending events, or 0 if there are none available.
slouken@7191
   621
 *
slouken@7191
   622
 *  \param event If not NULL, the next event is removed from the queue and
slouken@3407
   623
 *               stored in that area.
slouken@0
   624
 */
slouken@1895
   625
extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
slouken@0
   626
slouken@3407
   627
/**
slouken@3407
   628
 *  \brief Waits indefinitely for the next available event.
slouken@7191
   629
 *
slouken@3407
   630
 *  \return 1, or 0 if there was an error while waiting for events.
slouken@7191
   631
 *
slouken@7191
   632
 *  \param event If not NULL, the next event is removed from the queue and
slouken@3407
   633
 *               stored in that area.
slouken@0
   634
 */
slouken@1895
   635
extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
slouken@0
   636
slouken@3407
   637
/**
slouken@7191
   638
 *  \brief Waits until the specified timeout (in milliseconds) for the next
slouken@3407
   639
 *         available event.
slouken@7191
   640
 *
slouken@3407
   641
 *  \return 1, or 0 if there was an error while waiting for events.
slouken@7191
   642
 *
slouken@7191
   643
 *  \param event If not NULL, the next event is removed from the queue and
slouken@3407
   644
 *               stored in that area.
philipp@7188
   645
 *  \param timeout The timeout (in milliseconds) to wait for next event.
slouken@3072
   646
 */
slouken@3072
   647
extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
slouken@3072
   648
                                                 int timeout);
slouken@3072
   649
slouken@3407
   650
/**
slouken@3407
   651
 *  \brief Add an event to the event queue.
slouken@7191
   652
 *
slouken@7191
   653
 *  \return 1 on success, 0 if the event was filtered, or -1 if the event queue
slouken@3407
   654
 *          was full or there was some other error.
slouken@0
   655
 */
slouken@1895
   656
extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
slouken@0
   657
slouken@3407
   658
typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
slouken@0
   659
slouken@3407
   660
/**
slouken@3407
   661
 *  Sets up a filter to process all events before they change internal state and
slouken@3407
   662
 *  are posted to the internal event queue.
slouken@7191
   663
 *
philipp@7125
   664
 *  The filter is prototyped as:
slouken@3407
   665
 *  \code
slouken@3407
   666
 *      int SDL_EventFilter(void *userdata, SDL_Event * event);
slouken@3407
   667
 *  \endcode
slouken@3407
   668
 *
slouken@3407
   669
 *  If the filter returns 1, then the event will be added to the internal queue.
slouken@7191
   670
 *  If it returns 0, then the event will be dropped from the queue, but the
slouken@3407
   671
 *  internal state will still be updated.  This allows selective filtering of
slouken@3407
   672
 *  dynamically arriving events.
slouken@7191
   673
 *
slouken@7191
   674
 *  \warning  Be very careful of what you do in the event filter function, as
slouken@3407
   675
 *            it may run in a different thread!
slouken@7191
   676
 *
philipp@7278
   677
 *  There is one caveat when dealing with the ::SDL_QuitEvent event type.  The
slouken@3407
   678
 *  event filter is only called when the window manager desires to close the
slouken@3407
   679
 *  application window.  If the event filter returns 1, then the window will
slouken@3407
   680
 *  be closed, otherwise the window will remain open if possible.
slouken@3407
   681
 *
slouken@3407
   682
 *  If the quit event is generated by an interrupt signal, it will bypass the
slouken@3407
   683
 *  internal queue and be delivered to the application at the next event poll.
slouken@3407
   684
 */
slouken@1895
   685
extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
slouken@1895
   686
                                                void *userdata);
slouken@0
   687
slouken@3407
   688
/**
slouken@3407
   689
 *  Return the current event filter - can be used to "chain" filters.
slouken@3407
   690
 *  If there is no event filter set, this function returns SDL_FALSE.
slouken@3407
   691
 */
slouken@1895
   692
extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
slouken@1895
   693
                                                    void **userdata);
slouken@1895
   694
slouken@3407
   695
/**
slouken@5146
   696
 *  Add a function which is called when an event is added to the queue.
slouken@5146
   697
 */
slouken@5146
   698
extern DECLSPEC void SDLCALL SDL_AddEventWatch(SDL_EventFilter filter,
slouken@5146
   699
                                               void *userdata);
slouken@5146
   700
slouken@5146
   701
/**
slouken@5146
   702
 *  Remove an event watch function added with SDL_AddEventWatch()
slouken@5146
   703
 */
slouken@5146
   704
extern DECLSPEC void SDLCALL SDL_DelEventWatch(SDL_EventFilter filter,
slouken@5146
   705
                                               void *userdata);
slouken@5146
   706
slouken@5146
   707
/**
slouken@3407
   708
 *  Run the filter function on the current event queue, removing any
slouken@3407
   709
 *  events for which the filter returns 0.
slouken@3407
   710
 */
slouken@1895
   711
extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter,
slouken@1895
   712
                                              void *userdata);
slouken@0
   713
gabomdq@7678
   714
/* @{ */
slouken@7191
   715
#define SDL_QUERY   -1
slouken@7191
   716
#define SDL_IGNORE   0
slouken@7191
   717
#define SDL_DISABLE  0
slouken@7191
   718
#define SDL_ENABLE   1
slouken@3407
   719
slouken@3407
   720
/**
slouken@3407
   721
 *  This function allows you to set the state of processing certain events.
slouken@7191
   722
 *   - If \c state is set to ::SDL_IGNORE, that event will be automatically
slouken@3407
   723
 *     dropped from the event queue and will not event be filtered.
slouken@7191
   724
 *   - If \c state is set to ::SDL_ENABLE, that event will be processed
slouken@3407
   725
 *     normally.
slouken@7191
   726
 *   - If \c state is set to ::SDL_QUERY, SDL_EventState() will return the
slouken@3407
   727
 *     current processing state of the specified event.
slouken@3407
   728
 */
slouken@4429
   729
extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint32 type, int state);
gabomdq@7678
   730
/* @} */
slouken@4429
   731
#define SDL_GetEventState(type) SDL_EventState(type, SDL_QUERY)
slouken@4429
   732
slouken@4429
   733
/**
slouken@4429
   734
 *  This function allocates a set of user-defined events, and returns
slouken@4429
   735
 *  the beginning event number for that set of events.
slouken@4429
   736
 *
slouken@4429
   737
 *  If there aren't enough user-defined events left, this function
slouken@4429
   738
 *  returns (Uint32)-1
slouken@4429
   739
 */
slouken@4429
   740
extern DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
slouken@0
   741
slouken@0
   742
/* Ends C function definitions when using C++ */
slouken@0
   743
#ifdef __cplusplus
slouken@0
   744
}
slouken@0
   745
#endif
slouken@0
   746
#include "close_code.h"
slouken@0
   747
slouken@0
   748
#endif /* _SDL_events_h */
slouken@1895
   749
slouken@1895
   750
/* vi: set ts=4 sw=4 expandtab: */