include/SDL_events.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 06 Jul 2007 09:22:18 +0000
changeset 2152 003c1b5b07da
parent 2131 55c7932d1fdb
child 2300 c97ad1abe05b
permissions -rw-r--r--
Fixed bug #382

Added horizontal scrolling support
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@1312
     3
    Copyright (C) 1997-2006 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@1957
    63
    SDL_TEXTINPUT,              /**< Keyboard text input */
slouken@1895
    64
    SDL_MOUSEMOTION,            /**< Mouse moved */
slouken@1895
    65
    SDL_MOUSEBUTTONDOWN,        /**< Mouse button pressed */
slouken@1895
    66
    SDL_MOUSEBUTTONUP,          /**< Mouse button released */
slouken@1957
    67
    SDL_MOUSEWHEEL,             /**< Mouse wheel motion */
slouken@1895
    68
    SDL_JOYAXISMOTION,          /**< Joystick axis motion */
slouken@1895
    69
    SDL_JOYBALLMOTION,          /**< Joystick trackball motion */
slouken@1895
    70
    SDL_JOYHATMOTION,           /**< Joystick hat position change */
slouken@1895
    71
    SDL_JOYBUTTONDOWN,          /**< Joystick button pressed */
slouken@1895
    72
    SDL_JOYBUTTONUP,            /**< Joystick button released */
slouken@1895
    73
    SDL_QUIT,                   /**< User-requested quit */
slouken@1895
    74
    SDL_SYSWMEVENT,             /**< System specific event */
slouken@1895
    75
    SDL_EVENT_RESERVED1,        /**< Reserved for future use... */
slouken@1895
    76
    SDL_EVENT_RESERVED2,        /**< Reserved for future use... */
slouken@1895
    77
    SDL_EVENT_RESERVED3,        /**< Reserved for future use... */
slouken@1895
    78
    /* Events SDL_USEREVENT through SDL_MAXEVENTS-1 are for your use */
slouken@1895
    79
    SDL_USEREVENT = 24,
slouken@1895
    80
    /* This last event is only for bounding internal arrays
slouken@1895
    81
       It is the number of bits in the event mask datatype -- Uint32
slouken@1895
    82
     */
slouken@1895
    83
    SDL_NUMEVENTS = 32
slouken@1294
    84
} SDL_EventType;
slouken@0
    85
slouken@1895
    86
/**
slouken@1895
    87
 * \enum SDL_EventMask
slouken@1895
    88
 *
slouken@1895
    89
 * \brief Predefined event masks
slouken@1895
    90
 */
slouken@0
    91
#define SDL_EVENTMASK(X)	(1<<(X))
slouken@1895
    92
typedef enum
slouken@1895
    93
{
slouken@1895
    94
    SDL_WINDOWEVENTMASK = SDL_EVENTMASK(SDL_WINDOWEVENT),
slouken@1895
    95
    SDL_KEYDOWNMASK = SDL_EVENTMASK(SDL_KEYDOWN),
slouken@1895
    96
    SDL_KEYUPMASK = SDL_EVENTMASK(SDL_KEYUP),
slouken@1895
    97
    SDL_KEYEVENTMASK = SDL_EVENTMASK(SDL_KEYDOWN) | SDL_EVENTMASK(SDL_KEYUP),
slouken@1895
    98
    SDL_TEXTINPUTMASK = SDL_EVENTMASK(SDL_TEXTINPUT),
slouken@1895
    99
    SDL_MOUSEMOTIONMASK = SDL_EVENTMASK(SDL_MOUSEMOTION),
slouken@1895
   100
    SDL_MOUSEBUTTONDOWNMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN),
slouken@1895
   101
    SDL_MOUSEBUTTONUPMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
slouken@1895
   102
    SDL_MOUSEWHEELMASK = SDL_EVENTMASK(SDL_MOUSEWHEEL),
slouken@1895
   103
    SDL_MOUSEEVENTMASK = SDL_EVENTMASK(SDL_MOUSEMOTION) |
slouken@1895
   104
        SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN) | SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
slouken@1895
   105
    SDL_JOYAXISMOTIONMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION),
slouken@1895
   106
    SDL_JOYBALLMOTIONMASK = SDL_EVENTMASK(SDL_JOYBALLMOTION),
slouken@1895
   107
    SDL_JOYHATMOTIONMASK = SDL_EVENTMASK(SDL_JOYHATMOTION),
slouken@1895
   108
    SDL_JOYBUTTONDOWNMASK = SDL_EVENTMASK(SDL_JOYBUTTONDOWN),
slouken@1895
   109
    SDL_JOYBUTTONUPMASK = SDL_EVENTMASK(SDL_JOYBUTTONUP),
slouken@1895
   110
    SDL_JOYEVENTMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION) |
slouken@1895
   111
        SDL_EVENTMASK(SDL_JOYBALLMOTION) |
slouken@1895
   112
        SDL_EVENTMASK(SDL_JOYHATMOTION) |
slouken@1895
   113
        SDL_EVENTMASK(SDL_JOYBUTTONDOWN) | SDL_EVENTMASK(SDL_JOYBUTTONUP),
slouken@1895
   114
    SDL_QUITMASK = SDL_EVENTMASK(SDL_QUIT),
slouken@1895
   115
    SDL_SYSWMEVENTMASK = SDL_EVENTMASK(SDL_SYSWMEVENT)
slouken@1895
   116
} SDL_EventMask;
slouken@0
   117
#define SDL_ALLEVENTS		0xFFFFFFFF
slouken@0
   118
slouken@1895
   119
/**
slouken@1895
   120
 * \struct SDL_WindowEvent
slouken@1895
   121
 *
slouken@1914
   122
 * \brief Window state change event data (event.window.*)
slouken@1895
   123
 */
slouken@1895
   124
typedef struct SDL_WindowEvent
slouken@1895
   125
{
slouken@1895
   126
    Uint8 type;             /**< SDL_WINDOWEVENT */
slouken@1895
   127
    Uint8 event;            /**< SDL_WindowEventID */
slouken@1895
   128
    int data1;              /**< event dependent data */
slouken@1895
   129
    int data2;              /**< event dependent data */
slouken@1895
   130
    SDL_WindowID windowID;  /**< The associated window */
slouken@1895
   131
} SDL_WindowEvent;
slouken@0
   132
slouken@1895
   133
/**
slouken@1895
   134
 * \struct SDL_KeyboardEvent
slouken@1895
   135
 *
slouken@1914
   136
 * \brief Keyboard button event structure (event.key.*)
slouken@1895
   137
 */
slouken@1895
   138
typedef struct SDL_KeyboardEvent
slouken@1895
   139
{
slouken@1895
   140
    Uint8 type;             /**< SDL_KEYDOWN or SDL_KEYUP */
slouken@1895
   141
    Uint8 which;            /**< The keyboard device index */
slouken@1895
   142
    Uint8 state;            /**< SDL_PRESSED or SDL_RELEASED */
slouken@1895
   143
    SDL_keysym keysym;      /**< The key that was pressed or released */
slouken@1895
   144
    SDL_WindowID windowID;  /**< The window with keyboard focus, if any */
slouken@0
   145
} SDL_KeyboardEvent;
slouken@0
   146
slouken@1895
   147
/**
slouken@1895
   148
 * \struct SDL_TextInputEvent
slouken@1895
   149
 *
slouken@1914
   150
 * \brief Keyboard text input event structure (event.text.*)
slouken@1895
   151
 */
slouken@1895
   152
typedef struct SDL_TextInputEvent
slouken@1895
   153
{
slouken@1895
   154
    Uint8 type;             /**< SDL_TEXTINPUT */
slouken@1895
   155
    Uint8 which;            /**< The keyboard device index */
slouken@1895
   156
    char text[32];          /**< The input text */
slouken@1895
   157
    SDL_WindowID windowID;  /**< The window with keyboard focus, if any */
slouken@1895
   158
} SDL_TextInputEvent;
slouken@1895
   159
slouken@1895
   160
/**
slouken@1895
   161
 * \struct SDL_MouseMotionEvent
slouken@1895
   162
 *
slouken@1914
   163
 * \brief Mouse motion event structure (event.motion.*)
slouken@1895
   164
 */
slouken@1895
   165
typedef struct SDL_MouseMotionEvent
slouken@1895
   166
{
slouken@1895
   167
    Uint8 type;             /**< SDL_MOUSEMOTION */
slouken@1895
   168
    Uint8 which;            /**< The mouse device index */
slouken@1895
   169
    Uint8 state;            /**< The current button state */
slouken@1895
   170
    int x;                  /**< X coordinate, relative to window */
slouken@1895
   171
    int y;                  /**< Y coordinate, relative to window */
slouken@1895
   172
    int xrel;               /**< The relative motion in the X direction */
slouken@1895
   173
    int yrel;               /**< The relative motion in the Y direction */
slouken@1895
   174
    SDL_WindowID windowID;  /**< The window with mouse focus, if any */
slouken@0
   175
} SDL_MouseMotionEvent;
slouken@0
   176
slouken@1895
   177
/**
slouken@1895
   178
 * \struct SDL_MouseButtonEvent
slouken@1895
   179
 *
slouken@1914
   180
 * \brief Mouse button event structure (event.button.*)
slouken@1895
   181
 */
slouken@1895
   182
typedef struct SDL_MouseButtonEvent
slouken@1895
   183
{
slouken@1895
   184
    Uint8 type;             /**< SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP */
slouken@1895
   185
    Uint8 which;            /**< The mouse device index */
slouken@1895
   186
    Uint8 button;           /**< The mouse button index */
slouken@1895
   187
    Uint8 state;            /**< SDL_PRESSED or SDL_RELEASED */
slouken@1895
   188
    int x;                  /**< X coordinate, relative to window */
slouken@1895
   189
    int y;                  /**< Y coordinate, relative to window */
slouken@1895
   190
    SDL_WindowID windowID;  /**< The window with mouse focus, if any */
slouken@0
   191
} SDL_MouseButtonEvent;
slouken@0
   192
slouken@1895
   193
/**
slouken@1895
   194
 * \struct SDL_MouseWheelEvent
slouken@1895
   195
 *
slouken@1914
   196
 * \brief Mouse wheel event structure (event.wheel.*)
slouken@1895
   197
 */
slouken@1895
   198
typedef struct SDL_MouseWheelEvent
slouken@1895
   199
{
slouken@1895
   200
    Uint8 type;             /**< SDL_MOUSEWHEEL */
slouken@1895
   201
    Uint8 which;            /**< The mouse device index */
slouken@2152
   202
    int x;                  /**< The amount scrolled horizontally */
slouken@2152
   203
    int y;                  /**< The amount scrolled vertically */
slouken@1895
   204
    SDL_WindowID windowID;  /**< The window with mouse focus, if any */
slouken@1895
   205
} SDL_MouseWheelEvent;
slouken@1895
   206
slouken@1895
   207
/**
slouken@1895
   208
 * \struct SDL_JoyAxisEvent
slouken@1895
   209
 *
slouken@1914
   210
 * \brief Joystick axis motion event structure (event.jaxis.*)
slouken@1895
   211
 */
slouken@1895
   212
typedef struct SDL_JoyAxisEvent
slouken@1895
   213
{
slouken@1895
   214
    Uint8 type;         /**< SDL_JOYAXISMOTION */
slouken@1895
   215
    Uint8 which;        /**< The joystick device index */
slouken@1895
   216
    Uint8 axis;         /**< The joystick axis index */
slouken@1895
   217
    int value;          /**< The axis value (range: -32768 to 32767) */
slouken@0
   218
} SDL_JoyAxisEvent;
slouken@0
   219
slouken@1895
   220
/**
slouken@1895
   221
 * \struct SDL_JoyBallEvent
slouken@1895
   222
 *
slouken@1914
   223
 * \brief Joystick trackball motion event structure (event.jball.*)
slouken@1895
   224
 */
slouken@1895
   225
typedef struct SDL_JoyBallEvent
slouken@1895
   226
{
slouken@1895
   227
    Uint8 type;         /**< SDL_JOYBALLMOTION */
slouken@1895
   228
    Uint8 which;        /**< The joystick device index */
slouken@1895
   229
    Uint8 ball;         /**< The joystick trackball index */
slouken@1895
   230
    int xrel;           /**< The relative motion in the X direction */
slouken@1895
   231
    int yrel;           /**< The relative motion in the Y direction */
slouken@0
   232
} SDL_JoyBallEvent;
slouken@0
   233
slouken@1895
   234
/**
slouken@1895
   235
 * \struct SDL_JoyHatEvent
slouken@1895
   236
 *
slouken@1914
   237
 * \brief Joystick hat position change event structure (event.jhat.*)
slouken@1895
   238
 */
slouken@1895
   239
typedef struct SDL_JoyHatEvent
slouken@1895
   240
{
slouken@1895
   241
    Uint8 type;         /**< SDL_JOYHATMOTION */
slouken@1895
   242
    Uint8 which;        /**< The joystick device index */
slouken@1895
   243
    Uint8 hat;          /**< The joystick hat index */
slouken@1895
   244
    Uint8 value;        /**< The hat position value:
slouken@1895
   245
                             SDL_HAT_LEFTUP   SDL_HAT_UP       SDL_HAT_RIGHTUP
slouken@1895
   246
                             SDL_HAT_LEFT     SDL_HAT_CENTERED SDL_HAT_RIGHT
slouken@1895
   247
                             SDL_HAT_LEFTDOWN SDL_HAT_DOWN     SDL_HAT_RIGHTDOWN
slouken@1895
   248
                             Note that zero means the POV is centered.
slouken@1895
   249
                         */
slouken@0
   250
} SDL_JoyHatEvent;
slouken@0
   251
slouken@1895
   252
/**
slouken@1895
   253
 * \struct SDL_JoyButtonEvent
slouken@1895
   254
 *
slouken@1914
   255
 * \brief Joystick button event structure (event.jbutton.*)
slouken@1895
   256
 */
slouken@1895
   257
typedef struct SDL_JoyButtonEvent
slouken@1895
   258
{
slouken@1895
   259
    Uint8 type;         /**< SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP */
slouken@1895
   260
    Uint8 which;        /**< The joystick device index */
slouken@1895
   261
    Uint8 button;       /**< The joystick button index */
slouken@1895
   262
    Uint8 state;        /**< SDL_PRESSED or SDL_RELEASED */
slouken@0
   263
} SDL_JoyButtonEvent;
slouken@0
   264
slouken@1895
   265
/**
slouken@1895
   266
 * \struct SDL_QuitEvent
slouken@1895
   267
 *
slouken@1895
   268
 * \brief The "quit requested" event
slouken@0
   269
 */
slouken@1895
   270
typedef struct SDL_QuitEvent
slouken@1895
   271
{
slouken@1895
   272
    Uint8 type;         /**< SDL_QUIT */
slouken@1895
   273
} SDL_QuitEvent;
slouken@1895
   274
slouken@1895
   275
/**
slouken@1895
   276
 * \struct SDL_UserEvent
slouken@1895
   277
 *
slouken@1914
   278
 * \brief A user-defined event type (event.user.*)
slouken@1895
   279
 */
slouken@1895
   280
typedef struct SDL_UserEvent
slouken@1895
   281
{
bob@2131
   282
    Uint8 type;             /**< SDL_USEREVENT through SDL_NUMEVENTS-1 */
bob@2131
   283
    int code;               /**< User defined event code */
bob@2131
   284
    void *data1;            /**< User defined data pointer */
bob@2131
   285
    void *data2;            /**< User defined data pointer */
bob@2131
   286
    SDL_WindowID windowID;  /**< The associated window if any*/
slouken@1895
   287
} SDL_UserEvent;
slouken@1895
   288
slouken@1895
   289
/**
slouken@1895
   290
 * \struct SDL_SysWMEvent
slouken@1895
   291
 *
slouken@1914
   292
 * \brief A video driver dependent system event (event.syswm.*)
slouken@1895
   293
 *
slouken@1895
   294
 * \note If you want to use this event, you should include SDL_syswm.h
slouken@1895
   295
 */
slouken@1895
   296
struct SDL_SysWMmsg;
slouken@1895
   297
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
slouken@1895
   298
typedef struct SDL_SysWMEvent
slouken@1895
   299
{
slouken@1895
   300
    Uint8 type;         /**< SDL_SYSWMEVENT */
slouken@1895
   301
    SDL_SysWMmsg *msg;  /**< driver dependent data, defined in SDL_syswm.h */
slouken@1895
   302
} SDL_SysWMEvent;
slouken@1895
   303
slouken@1895
   304
/* Typedefs for backwards compatibility */
slouken@1895
   305
typedef struct SDL_ActiveEvent
slouken@1895
   306
{
slouken@1895
   307
    Uint8 type;
slouken@1895
   308
    Uint8 gain;
slouken@1895
   309
    Uint8 state;
slouken@1895
   310
} SDL_ActiveEvent;
slouken@1895
   311
typedef struct SDL_ResizeEvent
slouken@1895
   312
{
slouken@1895
   313
    Uint8 type;
slouken@1895
   314
    int w;
slouken@1895
   315
    int h;
slouken@0
   316
} SDL_ResizeEvent;
slouken@0
   317
slouken@1895
   318
/**
slouken@1895
   319
 * \union SDL_Event
slouken@1895
   320
 *
slouken@1895
   321
 * \brief General event structure
slouken@1895
   322
 */
slouken@1895
   323
typedef union SDL_Event
slouken@1895
   324
{
slouken@1895
   325
    Uint8 type;                     /**< Event type, shared with all events */
slouken@1895
   326
    SDL_WindowEvent window;         /**< Window event data */
slouken@1895
   327
    SDL_KeyboardEvent key;          /**< Keyboard event data */
slouken@1895
   328
    SDL_TextInputEvent text;                    /**< Text input event data */
slouken@1895
   329
    SDL_MouseMotionEvent motion;    /**< Mouse motion event data */
slouken@1895
   330
    SDL_MouseButtonEvent button;    /**< Mouse button event data */
slouken@1895
   331
    SDL_MouseWheelEvent wheel;                  /**< Mouse wheel event data */
slouken@1895
   332
    SDL_JoyAxisEvent jaxis;         /**< Joystick axis event data */
slouken@1895
   333
    SDL_JoyBallEvent jball;         /**< Joystick ball event data */
slouken@1895
   334
    SDL_JoyHatEvent jhat;           /**< Joystick hat event data */
slouken@1895
   335
    SDL_JoyButtonEvent jbutton;     /**< Joystick button event data */
slouken@1895
   336
    SDL_QuitEvent quit;             /**< Quit request event data */
slouken@1895
   337
    SDL_UserEvent user;             /**< Custom event data */
slouken@1895
   338
    SDL_SysWMEvent syswm;           /**< System dependent window event data */
slouken@0
   339
slouken@1895
   340
    /* Temporarily here for backwards compatibility */
slouken@1895
   341
    SDL_ActiveEvent active;
slouken@1895
   342
    SDL_ResizeEvent resize;
slouken@0
   343
} SDL_Event;
slouken@0
   344
slouken@0
   345
slouken@0
   346
/* Function prototypes */
slouken@0
   347
slouken@0
   348
/* Pumps the event loop, gathering events from the input devices.
slouken@0
   349
   This function updates the event queue and internal input device state.
slouken@0
   350
   This should only be run in the thread that sets the video mode.
slouken@0
   351
*/
slouken@337
   352
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
slouken@0
   353
slouken@0
   354
/* Checks the event queue for messages and optionally returns them.
slouken@0
   355
   If 'action' is SDL_ADDEVENT, up to 'numevents' events will be added to
slouken@0
   356
   the back of the event queue.
slouken@0
   357
   If 'action' is SDL_PEEKEVENT, up to 'numevents' events at the front
slouken@0
   358
   of the event queue, matching 'mask', will be returned and will not
slouken@0
   359
   be removed from the queue.
slouken@0
   360
   If 'action' is SDL_GETEVENT, up to 'numevents' events at the front 
slouken@0
   361
   of the event queue, matching 'mask', will be returned and will be
slouken@0
   362
   removed from the queue.
slouken@0
   363
   This function returns the number of events actually stored, or -1
slouken@0
   364
   if there was an error.  This function is thread-safe.
slouken@0
   365
*/
slouken@1895
   366
typedef enum
slouken@1895
   367
{
slouken@1895
   368
    SDL_ADDEVENT,
slouken@1895
   369
    SDL_PEEKEVENT,
slouken@1895
   370
    SDL_GETEVENT
slouken@0
   371
} SDL_eventaction;
slouken@0
   372
/* */
slouken@1895
   373
extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
slouken@1895
   374
                                           SDL_eventaction action,
slouken@1895
   375
                                           Uint32 mask);
slouken@1895
   376
slouken@1895
   377
/* Checks to see if certain event types are in the event queue.
slouken@1895
   378
 */
slouken@1895
   379
extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 mask);
slouken@0
   380
slouken@0
   381
/* Polls for currently pending events, and returns 1 if there are any pending
slouken@0
   382
   events, or 0 if there are none available.  If 'event' is not NULL, the next
slouken@0
   383
   event is removed from the queue and stored in that area.
slouken@0
   384
 */
slouken@1895
   385
extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
slouken@0
   386
slouken@0
   387
/* Waits indefinitely for the next available event, returning 1, or 0 if there
slouken@0
   388
   was an error while waiting for events.  If 'event' is not NULL, the next
slouken@0
   389
   event is removed from the queue and stored in that area.
slouken@0
   390
 */
slouken@1895
   391
extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
slouken@0
   392
slouken@0
   393
/* Add an event to the event queue.
slouken@1895
   394
   This function returns 1 on success, 0 if the event was filtered,
slouken@1895
   395
   or -1 if the event queue was full or there was some other error.
slouken@0
   396
 */
slouken@1895
   397
extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
slouken@0
   398
slouken@0
   399
/*
slouken@0
   400
  This function sets up a filter to process all events before they
slouken@0
   401
  change internal state and are posted to the internal event queue.
slouken@0
   402
slouken@0
   403
  The filter is protypted as:
slouken@0
   404
*/
slouken@1895
   405
typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
slouken@0
   406
/*
slouken@0
   407
  If the filter returns 1, then the event will be added to the internal queue.
slouken@0
   408
  If it returns 0, then the event will be dropped from the queue, but the 
slouken@0
   409
  internal state will still be updated.  This allows selective filtering of
slouken@0
   410
  dynamically arriving events.
slouken@0
   411
slouken@0
   412
  WARNING:  Be very careful of what you do in the event filter function, as 
slouken@0
   413
            it may run in a different thread!
slouken@0
   414
slouken@0
   415
  There is one caveat when dealing with the SDL_QUITEVENT event type.  The
slouken@0
   416
  event filter is only called when the window manager desires to close the
slouken@0
   417
  application window.  If the event filter returns 1, then the window will
slouken@0
   418
  be closed, otherwise the window will remain open if possible.
slouken@0
   419
  If the quit event is generated by an interrupt signal, it will bypass the
slouken@0
   420
  internal queue and be delivered to the application at the next event poll.
slouken@0
   421
*/
slouken@1895
   422
extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
slouken@1895
   423
                                                void *userdata);
slouken@0
   424
slouken@0
   425
/*
slouken@0
   426
  Return the current event filter - can be used to "chain" filters.
slouken@1895
   427
  If there is no event filter set, this function returns SDL_FALSE.
slouken@0
   428
*/
slouken@1895
   429
extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
slouken@1895
   430
                                                    void **userdata);
slouken@1895
   431
slouken@1895
   432
/*
slouken@1895
   433
  Run the filter function on the current event queue, removing any
slouken@1895
   434
  events for which the filter returns 0.
slouken@1895
   435
*/
slouken@1895
   436
extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter,
slouken@1895
   437
                                              void *userdata);
slouken@0
   438
slouken@0
   439
/*
slouken@0
   440
  This function allows you to set the state of processing certain events.
slouken@0
   441
  If 'state' is set to SDL_IGNORE, that event will be automatically dropped
slouken@0
   442
  from the event queue and will not event be filtered.
slouken@0
   443
  If 'state' is set to SDL_ENABLE, that event will be processed normally.
slouken@0
   444
  If 'state' is set to SDL_QUERY, SDL_EventState() will return the 
slouken@0
   445
  current processing state of the specified event.
slouken@0
   446
*/
slouken@0
   447
#define SDL_QUERY	-1
slouken@0
   448
#define SDL_IGNORE	 0
slouken@0
   449
#define SDL_DISABLE	 0
slouken@0
   450
#define SDL_ENABLE	 1
slouken@337
   451
extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint8 type, int state);
slouken@0
   452
slouken@0
   453
slouken@0
   454
/* Ends C function definitions when using C++ */
slouken@0
   455
#ifdef __cplusplus
slouken@1895
   456
/* *INDENT-OFF* */
slouken@0
   457
}
slouken@1895
   458
/* *INDENT-ON* */
slouken@0
   459
#endif
slouken@0
   460
#include "close_code.h"
slouken@0
   461
slouken@0
   462
#endif /* _SDL_events_h */
slouken@1895
   463
slouken@1895
   464
/* vi: set ts=4 sw=4 expandtab: */