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