include/SDL_events.h
author Edward Rudd <urkle@outoforder.cc>
Sun, 23 Nov 2014 21:09:54 -0500
changeset 9257 6f41196c2d6b
parent 9049 411e05b86ac3
child 9393 ed79a66e57e5
permissions -rw-r--r--
add in support for passing down the "natural" (or flipped) scrolling direction in the MouseWheelEvent event
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 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.md 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     /* Render events */
   138     SDL_RENDER_TARGETS_RESET = 0x2000, /**< The render targets have been reset and their contents need to be updated */
   139     SDL_RENDER_DEVICE_RESET, /**< The device has been reset and all textures need to be recreated */
   140 
   141     /** Events ::SDL_USEREVENT through ::SDL_LASTEVENT are for your use,
   142      *  and should be allocated with SDL_RegisterEvents()
   143      */
   144     SDL_USEREVENT    = 0x8000,
   145 
   146     /**
   147      *  This last event is only for bounding internal arrays
   148      */
   149     SDL_LASTEVENT    = 0xFFFF
   150 } SDL_EventType;
   151 
   152 /**
   153  *  \brief Fields shared by every event
   154  */
   155 typedef struct SDL_CommonEvent
   156 {
   157     Uint32 type;
   158     Uint32 timestamp;
   159 } SDL_CommonEvent;
   160 
   161 /**
   162  *  \brief Window state change event data (event.window.*)
   163  */
   164 typedef struct SDL_WindowEvent
   165 {
   166     Uint32 type;        /**< ::SDL_WINDOWEVENT */
   167     Uint32 timestamp;
   168     Uint32 windowID;    /**< The associated window */
   169     Uint8 event;        /**< ::SDL_WindowEventID */
   170     Uint8 padding1;
   171     Uint8 padding2;
   172     Uint8 padding3;
   173     Sint32 data1;       /**< event dependent data */
   174     Sint32 data2;       /**< event dependent data */
   175 } SDL_WindowEvent;
   176 
   177 /**
   178  *  \brief Keyboard button event structure (event.key.*)
   179  */
   180 typedef struct SDL_KeyboardEvent
   181 {
   182     Uint32 type;        /**< ::SDL_KEYDOWN or ::SDL_KEYUP */
   183     Uint32 timestamp;
   184     Uint32 windowID;    /**< The window with keyboard focus, if any */
   185     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
   186     Uint8 repeat;       /**< Non-zero if this is a key repeat */
   187     Uint8 padding2;
   188     Uint8 padding3;
   189     SDL_Keysym keysym;  /**< The key that was pressed or released */
   190 } SDL_KeyboardEvent;
   191 
   192 #define SDL_TEXTEDITINGEVENT_TEXT_SIZE (32)
   193 /**
   194  *  \brief Keyboard text editing event structure (event.edit.*)
   195  */
   196 typedef struct SDL_TextEditingEvent
   197 {
   198     Uint32 type;                                /**< ::SDL_TEXTEDITING */
   199     Uint32 timestamp;
   200     Uint32 windowID;                            /**< The window with keyboard focus, if any */
   201     char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE];  /**< The editing text */
   202     Sint32 start;                               /**< The start cursor of selected editing text */
   203     Sint32 length;                              /**< The length of selected editing text */
   204 } SDL_TextEditingEvent;
   205 
   206 
   207 #define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
   208 /**
   209  *  \brief Keyboard text input event structure (event.text.*)
   210  */
   211 typedef struct SDL_TextInputEvent
   212 {
   213     Uint32 type;                              /**< ::SDL_TEXTINPUT */
   214     Uint32 timestamp;
   215     Uint32 windowID;                          /**< The window with keyboard focus, if any */
   216     char text[SDL_TEXTINPUTEVENT_TEXT_SIZE];  /**< The input text */
   217 } SDL_TextInputEvent;
   218 
   219 /**
   220  *  \brief Mouse motion event structure (event.motion.*)
   221  */
   222 typedef struct SDL_MouseMotionEvent
   223 {
   224     Uint32 type;        /**< ::SDL_MOUSEMOTION */
   225     Uint32 timestamp;
   226     Uint32 windowID;    /**< The window with mouse focus, if any */
   227     Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
   228     Uint32 state;       /**< The current button state */
   229     Sint32 x;           /**< X coordinate, relative to window */
   230     Sint32 y;           /**< Y coordinate, relative to window */
   231     Sint32 xrel;        /**< The relative motion in the X direction */
   232     Sint32 yrel;        /**< The relative motion in the Y direction */
   233 } SDL_MouseMotionEvent;
   234 
   235 /**
   236  *  \brief Mouse button event structure (event.button.*)
   237  */
   238 typedef struct SDL_MouseButtonEvent
   239 {
   240     Uint32 type;        /**< ::SDL_MOUSEBUTTONDOWN or ::SDL_MOUSEBUTTONUP */
   241     Uint32 timestamp;
   242     Uint32 windowID;    /**< The window with mouse focus, if any */
   243     Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
   244     Uint8 button;       /**< The mouse button index */
   245     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
   246     Uint8 clicks;       /**< 1 for single-click, 2 for double-click, etc. */
   247     Uint8 padding1;
   248     Sint32 x;           /**< X coordinate, relative to window */
   249     Sint32 y;           /**< Y coordinate, relative to window */
   250 } SDL_MouseButtonEvent;
   251 
   252 /**
   253  *  \brief Mouse wheel event structure (event.wheel.*)
   254  */
   255 typedef struct SDL_MouseWheelEvent
   256 {
   257     Uint32 type;        /**< ::SDL_MOUSEWHEEL */
   258     Uint32 timestamp;
   259     Uint32 windowID;    /**< The window with mouse focus, if any */
   260     Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
   261     Sint32 x;           /**< The amount scrolled horizontally, positive to the right and negative to the left */
   262     Sint32 y;           /**< The amount scrolled vertically, positive away from the user and negative toward the user */
   263     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 */
   264 } SDL_MouseWheelEvent;
   265 
   266 /**
   267  *  \brief Joystick axis motion event structure (event.jaxis.*)
   268  */
   269 typedef struct SDL_JoyAxisEvent
   270 {
   271     Uint32 type;        /**< ::SDL_JOYAXISMOTION */
   272     Uint32 timestamp;
   273     SDL_JoystickID which; /**< The joystick instance id */
   274     Uint8 axis;         /**< The joystick axis index */
   275     Uint8 padding1;
   276     Uint8 padding2;
   277     Uint8 padding3;
   278     Sint16 value;       /**< The axis value (range: -32768 to 32767) */
   279     Uint16 padding4;
   280 } SDL_JoyAxisEvent;
   281 
   282 /**
   283  *  \brief Joystick trackball motion event structure (event.jball.*)
   284  */
   285 typedef struct SDL_JoyBallEvent
   286 {
   287     Uint32 type;        /**< ::SDL_JOYBALLMOTION */
   288     Uint32 timestamp;
   289     SDL_JoystickID which; /**< The joystick instance id */
   290     Uint8 ball;         /**< The joystick trackball index */
   291     Uint8 padding1;
   292     Uint8 padding2;
   293     Uint8 padding3;
   294     Sint16 xrel;        /**< The relative motion in the X direction */
   295     Sint16 yrel;        /**< The relative motion in the Y direction */
   296 } SDL_JoyBallEvent;
   297 
   298 /**
   299  *  \brief Joystick hat position change event structure (event.jhat.*)
   300  */
   301 typedef struct SDL_JoyHatEvent
   302 {
   303     Uint32 type;        /**< ::SDL_JOYHATMOTION */
   304     Uint32 timestamp;
   305     SDL_JoystickID which; /**< The joystick instance id */
   306     Uint8 hat;          /**< The joystick hat index */
   307     Uint8 value;        /**< The hat position value.
   308                          *   \sa ::SDL_HAT_LEFTUP ::SDL_HAT_UP ::SDL_HAT_RIGHTUP
   309                          *   \sa ::SDL_HAT_LEFT ::SDL_HAT_CENTERED ::SDL_HAT_RIGHT
   310                          *   \sa ::SDL_HAT_LEFTDOWN ::SDL_HAT_DOWN ::SDL_HAT_RIGHTDOWN
   311                          *
   312                          *   Note that zero means the POV is centered.
   313                          */
   314     Uint8 padding1;
   315     Uint8 padding2;
   316 } SDL_JoyHatEvent;
   317 
   318 /**
   319  *  \brief Joystick button event structure (event.jbutton.*)
   320  */
   321 typedef struct SDL_JoyButtonEvent
   322 {
   323     Uint32 type;        /**< ::SDL_JOYBUTTONDOWN or ::SDL_JOYBUTTONUP */
   324     Uint32 timestamp;
   325     SDL_JoystickID which; /**< The joystick instance id */
   326     Uint8 button;       /**< The joystick button index */
   327     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
   328     Uint8 padding1;
   329     Uint8 padding2;
   330 } SDL_JoyButtonEvent;
   331 
   332 /**
   333  *  \brief Joystick device event structure (event.jdevice.*)
   334  */
   335 typedef struct SDL_JoyDeviceEvent
   336 {
   337     Uint32 type;        /**< ::SDL_JOYDEVICEADDED or ::SDL_JOYDEVICEREMOVED */
   338     Uint32 timestamp;
   339     Sint32 which;       /**< The joystick device index for the ADDED event, instance id for the REMOVED event */
   340 } SDL_JoyDeviceEvent;
   341 
   342 
   343 /**
   344  *  \brief Game controller axis motion event structure (event.caxis.*)
   345  */
   346 typedef struct SDL_ControllerAxisEvent
   347 {
   348     Uint32 type;        /**< ::SDL_CONTROLLERAXISMOTION */
   349     Uint32 timestamp;
   350     SDL_JoystickID which; /**< The joystick instance id */
   351     Uint8 axis;         /**< The controller axis (SDL_GameControllerAxis) */
   352     Uint8 padding1;
   353     Uint8 padding2;
   354     Uint8 padding3;
   355     Sint16 value;       /**< The axis value (range: -32768 to 32767) */
   356     Uint16 padding4;
   357 } SDL_ControllerAxisEvent;
   358 
   359 
   360 /**
   361  *  \brief Game controller button event structure (event.cbutton.*)
   362  */
   363 typedef struct SDL_ControllerButtonEvent
   364 {
   365     Uint32 type;        /**< ::SDL_CONTROLLERBUTTONDOWN or ::SDL_CONTROLLERBUTTONUP */
   366     Uint32 timestamp;
   367     SDL_JoystickID which; /**< The joystick instance id */
   368     Uint8 button;       /**< The controller button (SDL_GameControllerButton) */
   369     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
   370     Uint8 padding1;
   371     Uint8 padding2;
   372 } SDL_ControllerButtonEvent;
   373 
   374 
   375 /**
   376  *  \brief Controller device event structure (event.cdevice.*)
   377  */
   378 typedef struct SDL_ControllerDeviceEvent
   379 {
   380     Uint32 type;        /**< ::SDL_CONTROLLERDEVICEADDED, ::SDL_CONTROLLERDEVICEREMOVED, or ::SDL_CONTROLLERDEVICEREMAPPED */
   381     Uint32 timestamp;
   382     Sint32 which;       /**< The joystick device index for the ADDED event, instance id for the REMOVED or REMAPPED event */
   383 } SDL_ControllerDeviceEvent;
   384 
   385 
   386 /**
   387  *  \brief Touch finger event structure (event.tfinger.*)
   388  */
   389 typedef struct SDL_TouchFingerEvent
   390 {
   391     Uint32 type;        /**< ::SDL_FINGERMOTION or ::SDL_FINGERDOWN or ::SDL_FINGERUP */
   392     Uint32 timestamp;
   393     SDL_TouchID touchId; /**< The touch device id */
   394     SDL_FingerID fingerId;
   395     float x;            /**< Normalized in the range 0...1 */
   396     float y;            /**< Normalized in the range 0...1 */
   397     float dx;           /**< Normalized in the range 0...1 */
   398     float dy;           /**< Normalized in the range 0...1 */
   399     float pressure;     /**< Normalized in the range 0...1 */
   400 } SDL_TouchFingerEvent;
   401 
   402 
   403 /**
   404  *  \brief Multiple Finger Gesture Event (event.mgesture.*)
   405  */
   406 typedef struct SDL_MultiGestureEvent
   407 {
   408     Uint32 type;        /**< ::SDL_MULTIGESTURE */
   409     Uint32 timestamp;
   410     SDL_TouchID touchId; /**< The touch device index */
   411     float dTheta;
   412     float dDist;
   413     float x;
   414     float y;
   415     Uint16 numFingers;
   416     Uint16 padding;
   417 } SDL_MultiGestureEvent;
   418 
   419 
   420 /**
   421  * \brief Dollar Gesture Event (event.dgesture.*)
   422  */
   423 typedef struct SDL_DollarGestureEvent
   424 {
   425     Uint32 type;        /**< ::SDL_DOLLARGESTURE */
   426     Uint32 timestamp;
   427     SDL_TouchID touchId; /**< The touch device id */
   428     SDL_GestureID gestureId;
   429     Uint32 numFingers;
   430     float error;
   431     float x;            /**< Normalized center of gesture */
   432     float y;            /**< Normalized center of gesture */
   433 } SDL_DollarGestureEvent;
   434 
   435 
   436 /**
   437  *  \brief An event used to request a file open by the system (event.drop.*)
   438  *         This event is disabled by default, you can enable it with SDL_EventState()
   439  *  \note If you enable this event, you must free the filename in the event.
   440  */
   441 typedef struct SDL_DropEvent
   442 {
   443     Uint32 type;        /**< ::SDL_DROPFILE */
   444     Uint32 timestamp;
   445     char *file;         /**< The file name, which should be freed with SDL_free() */
   446 } SDL_DropEvent;
   447 
   448 
   449 /**
   450  *  \brief The "quit requested" event
   451  */
   452 typedef struct SDL_QuitEvent
   453 {
   454     Uint32 type;        /**< ::SDL_QUIT */
   455     Uint32 timestamp;
   456 } SDL_QuitEvent;
   457 
   458 /**
   459  *  \brief OS Specific event
   460  */
   461 typedef struct SDL_OSEvent
   462 {
   463     Uint32 type;        /**< ::SDL_QUIT */
   464     Uint32 timestamp;
   465 } SDL_OSEvent;
   466 
   467 /**
   468  *  \brief A user-defined event type (event.user.*)
   469  */
   470 typedef struct SDL_UserEvent
   471 {
   472     Uint32 type;        /**< ::SDL_USEREVENT through ::SDL_LASTEVENT-1 */
   473     Uint32 timestamp;
   474     Uint32 windowID;    /**< The associated window if any */
   475     Sint32 code;        /**< User defined event code */
   476     void *data1;        /**< User defined data pointer */
   477     void *data2;        /**< User defined data pointer */
   478 } SDL_UserEvent;
   479 
   480 
   481 struct SDL_SysWMmsg;
   482 typedef struct SDL_SysWMmsg SDL_SysWMmsg;
   483 
   484 /**
   485  *  \brief A video driver dependent system event (event.syswm.*)
   486  *         This event is disabled by default, you can enable it with SDL_EventState()
   487  *
   488  *  \note If you want to use this event, you should include SDL_syswm.h.
   489  */
   490 typedef struct SDL_SysWMEvent
   491 {
   492     Uint32 type;        /**< ::SDL_SYSWMEVENT */
   493     Uint32 timestamp;
   494     SDL_SysWMmsg *msg;  /**< driver dependent data, defined in SDL_syswm.h */
   495 } SDL_SysWMEvent;
   496 
   497 /**
   498  *  \brief General event structure
   499  */
   500 typedef union SDL_Event
   501 {
   502     Uint32 type;                    /**< Event type, shared with all events */
   503     SDL_CommonEvent common;         /**< Common event data */
   504     SDL_WindowEvent window;         /**< Window event data */
   505     SDL_KeyboardEvent key;          /**< Keyboard event data */
   506     SDL_TextEditingEvent edit;      /**< Text editing event data */
   507     SDL_TextInputEvent text;        /**< Text input event data */
   508     SDL_MouseMotionEvent motion;    /**< Mouse motion event data */
   509     SDL_MouseButtonEvent button;    /**< Mouse button event data */
   510     SDL_MouseWheelEvent wheel;      /**< Mouse wheel event data */
   511     SDL_JoyAxisEvent jaxis;         /**< Joystick axis event data */
   512     SDL_JoyBallEvent jball;         /**< Joystick ball event data */
   513     SDL_JoyHatEvent jhat;           /**< Joystick hat event data */
   514     SDL_JoyButtonEvent jbutton;     /**< Joystick button event data */
   515     SDL_JoyDeviceEvent jdevice;     /**< Joystick device change event data */
   516     SDL_ControllerAxisEvent caxis;      /**< Game Controller axis event data */
   517     SDL_ControllerButtonEvent cbutton;  /**< Game Controller button event data */
   518     SDL_ControllerDeviceEvent cdevice;  /**< Game Controller device event data */
   519     SDL_QuitEvent quit;             /**< Quit request event data */
   520     SDL_UserEvent user;             /**< Custom event data */
   521     SDL_SysWMEvent syswm;           /**< System dependent window event data */
   522     SDL_TouchFingerEvent tfinger;   /**< Touch finger event data */
   523     SDL_MultiGestureEvent mgesture; /**< Gesture event data */
   524     SDL_DollarGestureEvent dgesture; /**< Gesture event data */
   525     SDL_DropEvent drop;             /**< Drag and drop event data */
   526 
   527     /* This is necessary for ABI compatibility between Visual C++ and GCC
   528        Visual C++ will respect the push pack pragma and use 52 bytes for
   529        this structure, and GCC will use the alignment of the largest datatype
   530        within the union, which is 8 bytes.
   531 
   532        So... we'll add padding to force the size to be 56 bytes for both.
   533     */
   534     Uint8 padding[56];
   535 } SDL_Event;
   536 
   537 
   538 /* Function prototypes */
   539 
   540 /**
   541  *  Pumps the event loop, gathering events from the input devices.
   542  *
   543  *  This function updates the event queue and internal input device state.
   544  *
   545  *  This should only be run in the thread that sets the video mode.
   546  */
   547 extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
   548 
   549 /* @{ */
   550 typedef enum
   551 {
   552     SDL_ADDEVENT,
   553     SDL_PEEKEVENT,
   554     SDL_GETEVENT
   555 } SDL_eventaction;
   556 
   557 /**
   558  *  Checks the event queue for messages and optionally returns them.
   559  *
   560  *  If \c action is ::SDL_ADDEVENT, up to \c numevents events will be added to
   561  *  the back of the event queue.
   562  *
   563  *  If \c action is ::SDL_PEEKEVENT, 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 not be removed from the queue.
   566  *
   567  *  If \c action is ::SDL_GETEVENT, up to \c numevents events at the front
   568  *  of the event queue, within the specified minimum and maximum type,
   569  *  will be returned and will be removed from the queue.
   570  *
   571  *  \return The number of events actually stored, or -1 if there was an error.
   572  *
   573  *  This function is thread-safe.
   574  */
   575 extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
   576                                            SDL_eventaction action,
   577                                            Uint32 minType, Uint32 maxType);
   578 /* @} */
   579 
   580 /**
   581  *  Checks to see if certain event types are in the event queue.
   582  */
   583 extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 type);
   584 extern DECLSPEC SDL_bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType);
   585 
   586 /**
   587  *  This function clears events from the event queue
   588  *  This function only affects currently queued events. If you want to make
   589  *  sure that all pending OS events are flushed, you can call SDL_PumpEvents()
   590  *  on the main thread immediately before the flush call.
   591  */
   592 extern DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type);
   593 extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
   594 
   595 /**
   596  *  \brief Polls for currently pending events.
   597  *
   598  *  \return 1 if there are any pending events, or 0 if there are none available.
   599  *
   600  *  \param event If not NULL, the next event is removed from the queue and
   601  *               stored in that area.
   602  */
   603 extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
   604 
   605 /**
   606  *  \brief Waits indefinitely for the next available event.
   607  *
   608  *  \return 1, or 0 if there was an error while waiting for events.
   609  *
   610  *  \param event If not NULL, the next event is removed from the queue and
   611  *               stored in that area.
   612  */
   613 extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
   614 
   615 /**
   616  *  \brief Waits until the specified timeout (in milliseconds) for the next
   617  *         available event.
   618  *
   619  *  \return 1, or 0 if there was an error while waiting for events.
   620  *
   621  *  \param event If not NULL, the next event is removed from the queue and
   622  *               stored in that area.
   623  *  \param timeout The timeout (in milliseconds) to wait for next event.
   624  */
   625 extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
   626                                                  int timeout);
   627 
   628 /**
   629  *  \brief Add an event to the event queue.
   630  *
   631  *  \return 1 on success, 0 if the event was filtered, or -1 if the event queue
   632  *          was full or there was some other error.
   633  */
   634 extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
   635 
   636 typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
   637 
   638 /**
   639  *  Sets up a filter to process all events before they change internal state and
   640  *  are posted to the internal event queue.
   641  *
   642  *  The filter is prototyped as:
   643  *  \code
   644  *      int SDL_EventFilter(void *userdata, SDL_Event * event);
   645  *  \endcode
   646  *
   647  *  If the filter returns 1, then the event will be added to the internal queue.
   648  *  If it returns 0, then the event will be dropped from the queue, but the
   649  *  internal state will still be updated.  This allows selective filtering of
   650  *  dynamically arriving events.
   651  *
   652  *  \warning  Be very careful of what you do in the event filter function, as
   653  *            it may run in a different thread!
   654  *
   655  *  There is one caveat when dealing with the ::SDL_QuitEvent event type.  The
   656  *  event filter is only called when the window manager desires to close the
   657  *  application window.  If the event filter returns 1, then the window will
   658  *  be closed, otherwise the window will remain open if possible.
   659  *
   660  *  If the quit event is generated by an interrupt signal, it will bypass the
   661  *  internal queue and be delivered to the application at the next event poll.
   662  */
   663 extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
   664                                                 void *userdata);
   665 
   666 /**
   667  *  Return the current event filter - can be used to "chain" filters.
   668  *  If there is no event filter set, this function returns SDL_FALSE.
   669  */
   670 extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
   671                                                     void **userdata);
   672 
   673 /**
   674  *  Add a function which is called when an event is added to the queue.
   675  */
   676 extern DECLSPEC void SDLCALL SDL_AddEventWatch(SDL_EventFilter filter,
   677                                                void *userdata);
   678 
   679 /**
   680  *  Remove an event watch function added with SDL_AddEventWatch()
   681  */
   682 extern DECLSPEC void SDLCALL SDL_DelEventWatch(SDL_EventFilter filter,
   683                                                void *userdata);
   684 
   685 /**
   686  *  Run the filter function on the current event queue, removing any
   687  *  events for which the filter returns 0.
   688  */
   689 extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter,
   690                                               void *userdata);
   691 
   692 /* @{ */
   693 #define SDL_QUERY   -1
   694 #define SDL_IGNORE   0
   695 #define SDL_DISABLE  0
   696 #define SDL_ENABLE   1
   697 
   698 /**
   699  *  This function allows you to set the state of processing certain events.
   700  *   - If \c state is set to ::SDL_IGNORE, that event will be automatically
   701  *     dropped from the event queue and will not event be filtered.
   702  *   - If \c state is set to ::SDL_ENABLE, that event will be processed
   703  *     normally.
   704  *   - If \c state is set to ::SDL_QUERY, SDL_EventState() will return the
   705  *     current processing state of the specified event.
   706  */
   707 extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint32 type, int state);
   708 /* @} */
   709 #define SDL_GetEventState(type) SDL_EventState(type, SDL_QUERY)
   710 
   711 /**
   712  *  This function allocates a set of user-defined events, and returns
   713  *  the beginning event number for that set of events.
   714  *
   715  *  If there aren't enough user-defined events left, this function
   716  *  returns (Uint32)-1
   717  */
   718 extern DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
   719 
   720 /* Ends C function definitions when using C++ */
   721 #ifdef __cplusplus
   722 }
   723 #endif
   724 #include "close_code.h"
   725 
   726 #endif /* _SDL_events_h */
   727 
   728 /* vi: set ts=4 sw=4 expandtab: */