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