include/SDL_events.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 12 Jul 2010 21:09:23 -0700
changeset 4661 03dcb795c583
parent 4659 063b9455bd1a
parent 4503 524dfefd554c
child 4662 3c4e0130c9b1
permissions -rw-r--r--
Merged changes from the main SDL codebase
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2010 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /**
    24  *  \file SDL_events.h
    25  *  
    26  *  Include file for SDL event handling.
    27  */
    28 
    29 #ifndef _SDL_events_h
    30 #define _SDL_events_h
    31 
    32 #include "SDL_stdinc.h"
    33 #include "SDL_error.h"
    34 #include "SDL_video.h"
    35 #include "SDL_keyboard.h"
    36 #include "SDL_mouse.h"
    37 #include "SDL_joystick.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 /* *INDENT-OFF* */
    46 extern "C" {
    47 /* *INDENT-ON* */
    48 #endif
    49 
    50 /* General keyboard/mouse state definitions */
    51 #define SDL_RELEASED	0
    52 #define SDL_PRESSED	1
    53 
    54 /**
    55  * \brief The types of events that can be delivered.
    56  */
    57 typedef enum
    58 {
    59     SDL_FIRSTEVENT     = 0,     /**< Unused (do not remove) */
    60 
    61     /* Application events */
    62     SDL_QUIT           = 0x100, /**< User-requested quit */
    63 
    64     /* Window events */
    65     SDL_WINDOWEVENT    = 0x200, /**< Window state change */
    66     SDL_SYSWMEVENT,             /**< System specific event */
    67 
    68     /* Keyboard events */
    69     SDL_KEYDOWN        = 0x300, /**< Keys pressed */
    70     SDL_KEYUP,                  /**< Keys released */
    71     SDL_TEXTEDITING,            /**< Keyboard text editing (composition) */
    72     SDL_TEXTINPUT,              /**< Keyboard text input */
    73 
    74     /* Mouse events */
    75     SDL_MOUSEMOTION    = 0x400, /**< Mouse moved */
    76     SDL_MOUSEBUTTONDOWN,        /**< Mouse button pressed */
    77     SDL_MOUSEBUTTONUP,          /**< Mouse button released */
    78     SDL_MOUSEWHEEL,             /**< Mouse wheel motion */
    79 
    80     /* Tablet or multiple mice input device events */
    81     SDL_INPUTMOTION    = 0x500, /**< Input moved */
    82     SDL_INPUTBUTTONDOWN,        /**< Input button pressed */
    83     SDL_INPUTBUTTONUP,          /**< Input button released */
    84     SDL_INPUTWHEEL,             /**< Input wheel motion */
    85     SDL_INPUTPROXIMITYIN,       /**< Input pen entered proximity */
    86     SDL_INPUTPROXIMITYOUT,      /**< Input pen left proximity */
    87 
    88     /* Joystick events */
    89     SDL_JOYAXISMOTION  = 0x600, /**< Joystick axis motion */
    90     SDL_JOYBALLMOTION,          /**< Joystick trackball motion */
    91     SDL_JOYHATMOTION,           /**< Joystick hat position change */
    92     SDL_JOYBUTTONDOWN,          /**< Joystick button pressed */
    93     SDL_JOYBUTTONUP,            /**< Joystick button released */
    94 
    95     /* Touch events */
    96     SDL_FINGERDOWN      = 0x700,
    97     SDL_FINGERUP,
    98     SDL_FINGERMOTION,
    99     SDL_TOUCHBUTTONDOWN,
   100     SDL_TOUCHBUTTONUP,    
   101 
   102     /* Gesture events */
   103     SDL_DOLLARGESTURE   = 0x800,
   104     SDL_DOLLARRECORD,
   105     SDL_MULTIGESTURE,
   106 
   107     /* Clipboard events */
   108     SDL_CLIPBOARDUPDATE = 0x900, /**< The clipboard changed */
   109 
   110     /* Obsolete events */
   111     SDL_EVENT_COMPAT1 = 0x7000, /**< SDL 1.2 events for compatibility */
   112     SDL_EVENT_COMPAT2,
   113     SDL_EVENT_COMPAT3,
   114 
   115 
   116     /** Events ::SDL_USEREVENT through ::SDL_LASTEVENT are for your use,
   117      *  and should be allocated with SDL_RegisterEvents()
   118      */
   119     SDL_USEREVENT    = 0x8000,
   120 
   121     /**
   122      *  This last event is only for bounding internal arrays
   123      */
   124     SDL_LASTEVENT    = 0xFFFF
   125 } SDL_EventType;
   126 
   127 /**
   128  *  \brief Window state change event data (event.window.*)
   129  */
   130 typedef struct SDL_WindowEvent
   131 {
   132     Uint32 type;        /**< ::SDL_WINDOWEVENT */
   133     Uint32 windowID;    /**< The associated window */
   134     Uint8 event;        /**< ::SDL_WindowEventID */
   135     Uint8 padding1;
   136     Uint8 padding2;
   137     Uint8 padding3;
   138     int data1;          /**< event dependent data */
   139     int data2;          /**< event dependent data */
   140 } SDL_WindowEvent;
   141 
   142 /**
   143  *  \brief Keyboard button event structure (event.key.*)
   144  */
   145 typedef struct SDL_KeyboardEvent
   146 {
   147     Uint32 type;        /**< ::SDL_KEYDOWN or ::SDL_KEYUP */
   148     Uint32 windowID;    /**< The window with keyboard focus, if any */
   149     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
   150     Uint8 padding1;
   151     Uint8 padding2;
   152     Uint8 padding3;
   153     SDL_keysym keysym;  /**< The key that was pressed or released */
   154 } SDL_KeyboardEvent;
   155 
   156 #define SDL_TEXTEDITINGEVENT_TEXT_SIZE (32)
   157 /**
   158  *  \brief Keyboard text editing event structure (event.edit.*)
   159  */
   160 typedef struct SDL_TextEditingEvent
   161 {
   162     Uint32 type;                                /**< ::SDL_TEXTEDITING */
   163     Uint32 windowID;                            /**< The window with keyboard focus, if any */
   164     char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE];  /**< The editing text */
   165     int start;                                  /**< The start cursor of selected editing text */
   166     int length;                                 /**< The length of selected editing text */
   167 } SDL_TextEditingEvent;
   168 
   169 
   170 #define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
   171 /**
   172  *  \brief Keyboard text input event structure (event.text.*)
   173  */
   174 typedef struct SDL_TextInputEvent
   175 {
   176     Uint32 type;                              /**< ::SDL_TEXTINPUT */
   177     Uint32 windowID;                          /**< The window with keyboard focus, if any */
   178     char text[SDL_TEXTINPUTEVENT_TEXT_SIZE];  /**< The input text */
   179 } SDL_TextInputEvent;
   180 
   181 /**
   182  *  \brief Mouse motion event structure (event.motion.*)
   183  */
   184 typedef struct SDL_MouseMotionEvent
   185 {
   186     Uint32 type;        /**< ::SDL_MOUSEMOTION */
   187     Uint32 windowID;    /**< The window with mouse focus, if any */
   188     Uint8 state;        /**< The current button state */
   189     Uint8 padding1;
   190     Uint8 padding2;
   191     Uint8 padding3;
   192     int x;              /**< X coordinate, relative to window */
   193     int y;              /**< Y coordinate, relative to window */
   194     int xrel;           /**< The relative motion in the X direction */
   195     int yrel;           /**< The relative motion in the Y direction */
   196 } SDL_MouseMotionEvent;
   197 
   198 /**
   199  *  \brief Mouse button event structure (event.button.*)
   200  */
   201 typedef struct SDL_MouseButtonEvent
   202 {
   203     Uint32 type;        /**< ::SDL_MOUSEBUTTONDOWN or ::SDL_MOUSEBUTTONUP */
   204     Uint32 windowID;    /**< The window with mouse focus, if any */
   205     Uint8 button;       /**< The mouse button index */
   206     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
   207     Uint8 padding1;
   208     Uint8 padding2;
   209     int x;              /**< X coordinate, relative to window */
   210     int y;              /**< Y coordinate, relative to window */
   211 } SDL_MouseButtonEvent;
   212 
   213 /**
   214  *  \brief Mouse wheel event structure (event.wheel.*)
   215  */
   216 typedef struct SDL_MouseWheelEvent
   217 {
   218     Uint32 type;        /**< ::SDL_MOUSEWHEEL */
   219     Uint32 windowID;    /**< The window with mouse focus, if any */
   220     int x;              /**< The amount scrolled horizontally */
   221     int y;              /**< The amount scrolled vertically */
   222 } SDL_MouseWheelEvent;
   223 
   224 /**
   225  *  \brief Joystick axis motion event structure (event.jaxis.*)
   226  */
   227 typedef struct SDL_JoyAxisEvent
   228 {
   229     Uint32 type;        /**< ::SDL_JOYAXISMOTION */
   230     Uint8 which;        /**< The joystick device index */
   231     Uint8 axis;         /**< The joystick axis index */
   232     Uint8 padding1;
   233     Uint8 padding2;
   234     int value;          /**< The axis value (range: -32768 to 32767) */
   235 } SDL_JoyAxisEvent;
   236 
   237 /**
   238  *  \brief Joystick trackball motion event structure (event.jball.*)
   239  */
   240 typedef struct SDL_JoyBallEvent
   241 {
   242     Uint32 type;        /**< ::SDL_JOYBALLMOTION */
   243     Uint8 which;        /**< The joystick device index */
   244     Uint8 ball;         /**< The joystick trackball index */
   245     Uint8 padding1;
   246     Uint8 padding2;
   247     int xrel;           /**< The relative motion in the X direction */
   248     int yrel;           /**< The relative motion in the Y direction */
   249 } SDL_JoyBallEvent;
   250 
   251 /**
   252  *  \brief Joystick hat position change event structure (event.jhat.*)
   253  */
   254 typedef struct SDL_JoyHatEvent
   255 {
   256     Uint32 type;        /**< ::SDL_JOYHATMOTION */
   257     Uint8 which;        /**< The joystick device index */
   258     Uint8 hat;          /**< The joystick hat index */
   259     Uint8 value;        /**< The hat position value.
   260                          *   \sa ::SDL_HAT_LEFTUP ::SDL_HAT_UP ::SDL_HAT_RIGHTUP
   261                          *   \sa ::SDL_HAT_LEFT ::SDL_HAT_CENTERED ::SDL_HAT_RIGHT
   262                          *   \sa ::SDL_HAT_LEFTDOWN ::SDL_HAT_DOWN ::SDL_HAT_RIGHTDOWN
   263                          *   
   264                          *   Note that zero means the POV is centered.
   265                          */
   266     Uint8 padding1;
   267 } SDL_JoyHatEvent;
   268 
   269 /**
   270  *  \brief Joystick button event structure (event.jbutton.*)
   271  */
   272 typedef struct SDL_JoyButtonEvent
   273 {
   274     Uint32 type;        /**< ::SDL_JOYBUTTONDOWN or ::SDL_JOYBUTTONUP */
   275     Uint8 which;        /**< The joystick device index */
   276     Uint8 button;       /**< The joystick button index */
   277     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
   278     Uint8 padding1;
   279 } SDL_JoyButtonEvent;
   280 
   281 
   282 /**
   283  *  \brief Touch finger motion/finger event structure (event.tmotion.*)
   284  */
   285 typedef struct SDL_TouchFingerEvent
   286 {
   287     Uint32 type;        /**< ::SDL_FINGERMOTION OR 
   288 			   SDL_FINGERDOWN OR SDL_FINGERUP*/
   289     Uint32 windowID;    /**< The window with mouse focus, if any */
   290     Uint8 touchId;        /**< The touch device id */
   291     Uint8 state;        /**< The current button state */
   292     Uint8 fingerId;
   293     Uint8 padding1;
   294     int x;
   295     int y;
   296     int pressure;
   297 } SDL_TouchFingerEvent;
   298 
   299 
   300 /**
   301  *  \brief Touch finger motion/finger event structure (event.tmotion.*)
   302  */
   303 typedef struct SDL_TouchButtonEvent
   304 {
   305     Uint32 type;        /**< ::SDL_TOUCHBUTTONUP OR SDL_TOUCHBUTTONDOWN */
   306     Uint32 windowID;    /**< The window with mouse focus, if any */
   307     Uint8 touchId;        /**< The touch device index */
   308     Uint8 state;        /**< The current button state */
   309     Uint8 button;        /**< The button changing state */
   310     Uint8 padding1;
   311 
   312 } SDL_TouchButtonEvent;
   313 
   314 
   315 
   316 /**
   317  *  \brief Multiple Finger Gesture Event
   318  */
   319 typedef struct SDL_MultiGestureEvent
   320 {
   321     Uint32 type;        /**< ::SDL_MULTIGESTURE */
   322     Uint32 windowID;    /**< The window with mouse focus, if any */
   323     Uint8 touchId;        /**< The touch device index */
   324     Uint8 padding1;
   325     Uint8 padding2;
   326     Uint8 padding3;
   327     float dTheta;
   328     float dDist;
   329     float x;  //currently 0...1. Change to screen coords?
   330     float y;  
   331 
   332 } SDL_MultiGestureEvent;
   333 
   334 typedef struct SDL_DollarGestureEvent
   335 {
   336     Uint32 type;        /**< ::SDL_DOLLARGESTURE */
   337     Uint32 windowID;    /**< The window with mouse focus, if any */
   338     Uint8 touchId;        /**< The touch device index */
   339     Uint8 padding1;
   340     Uint8 padding2;
   341     Uint8 padding3;
   342     unsigned long gestureId;
   343     float error;
   344   /*
   345     //TODO: Enable to give location?
   346     float x;  //currently 0...1. Change to screen coords?
   347     float y;  
   348   */
   349 } SDL_DollarGestureEvent;
   350 
   351 
   352 
   353 
   354 /**
   355  *  \brief The "quit requested" event
   356  */
   357 typedef struct SDL_QuitEvent
   358 {
   359     Uint32 type;        /**< ::SDL_QUIT */
   360 } SDL_QuitEvent;
   361 
   362 /**
   363  *  \brief A user-defined event type (event.user.*)
   364  */
   365 typedef struct SDL_UserEvent
   366 {
   367     Uint32 type;        /**< ::SDL_USEREVENT through ::SDL_NUMEVENTS-1 */
   368     Uint32 windowID;    /**< The associated window if any */
   369     int code;           /**< User defined event code */
   370     void *data1;        /**< User defined data pointer */
   371     void *data2;        /**< User defined data pointer */
   372 } SDL_UserEvent;
   373 
   374 struct SDL_SysWMmsg;
   375 typedef struct SDL_SysWMmsg SDL_SysWMmsg;
   376 
   377 /**
   378  *  \brief A video driver dependent system event (event.syswm.*)
   379  *  
   380  *  \note If you want to use this event, you should include SDL_syswm.h.
   381  */
   382 typedef struct SDL_SysWMEvent
   383 {
   384     Uint32 type;        /**< ::SDL_SYSWMEVENT */
   385     SDL_SysWMmsg *msg;  /**< driver dependent data, defined in SDL_syswm.h */
   386 } SDL_SysWMEvent;
   387 
   388 #ifndef SDL_NO_COMPAT
   389 /**
   390  *  \addtogroup Compatibility 
   391  */
   392 /*@{*/
   393 
   394 /**
   395  *  \name Typedefs for backwards compatibility
   396  */
   397 /*@{*/
   398 typedef struct SDL_ActiveEvent
   399 {
   400     Uint32 type;
   401     Uint8 gain;
   402     Uint8 state;
   403 } SDL_ActiveEvent;
   404 
   405 typedef struct SDL_ResizeEvent
   406 {
   407     Uint32 type;
   408     int w;
   409     int h;
   410 } SDL_ResizeEvent;
   411 /*@}*/
   412 
   413 /*@}*//*Compatibility*/
   414 #endif
   415 
   416 /**
   417  *  \brief General event structure
   418  */
   419 typedef union SDL_Event
   420 {
   421     Uint32 type;                    /**< Event type, shared with all events */
   422     SDL_WindowEvent window;         /**< Window event data */
   423     SDL_KeyboardEvent key;          /**< Keyboard event data */
   424     SDL_TextEditingEvent edit;      /**< Text editing event data */
   425     SDL_TextInputEvent text;        /**< Text input event data */
   426     SDL_MouseMotionEvent motion;    /**< Mouse motion event data */
   427     SDL_MouseButtonEvent button;    /**< Mouse button event data */
   428     SDL_MouseWheelEvent wheel;      /**< Mouse wheel event data */
   429     SDL_JoyAxisEvent jaxis;         /**< Joystick axis event data */
   430     SDL_JoyBallEvent jball;         /**< Joystick ball event data */
   431     SDL_JoyHatEvent jhat;           /**< Joystick hat event data */
   432     SDL_JoyButtonEvent jbutton;     /**< Joystick button event data */
   433     SDL_QuitEvent quit;             /**< Quit request event data */
   434     SDL_UserEvent user;             /**< Custom event data */
   435     SDL_SysWMEvent syswm;           /**< System dependent window event data */
   436     SDL_TouchFingerEvent tfinger;   /**< Touch finger event data */
   437     SDL_TouchButtonEvent tbutton;   /**< Touch button event data */
   438     SDL_MultiGestureEvent mgesture; /**< Multi Finger Gesture data*/
   439     SDL_DollarGestureEvent dgesture; /**< Multi Finger Gesture data*/
   440 
   441     /** Temporarily here for backwards compatibility */
   442     /*@{*/
   443 #ifndef SDL_NO_COMPAT
   444     SDL_ActiveEvent active;
   445     SDL_ResizeEvent resize;
   446 #endif
   447     /*@}*/
   448 } SDL_Event;
   449 
   450 
   451 /* Function prototypes */
   452 
   453 /**
   454  *  Pumps the event loop, gathering events from the input devices.
   455  *  
   456  *  This function updates the event queue and internal input device state.
   457  *  
   458  *  This should only be run in the thread that sets the video mode.
   459  */
   460 extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
   461 
   462 /*@{*/
   463 typedef enum
   464 {
   465     SDL_ADDEVENT,
   466     SDL_PEEKEVENT,
   467     SDL_GETEVENT
   468 } SDL_eventaction;
   469 
   470 /**
   471  *  Checks the event queue for messages and optionally returns them.
   472  *  
   473  *  If \c action is ::SDL_ADDEVENT, up to \c numevents events will be added to
   474  *  the back of the event queue.
   475  *  
   476  *  If \c action is ::SDL_PEEKEVENT, up to \c numevents events at the front
   477  *  of the event queue, matching \c mask, will be returned and will not
   478  *  be removed from the queue.
   479  *  
   480  *  If \c action is ::SDL_GETEVENT, up to \c numevents events at the front 
   481  *  of the event queue, matching \c mask, will be returned and will be
   482  *  removed from the queue.
   483  *  
   484  *  \return The number of events actually stored, or -1 if there was an error.
   485  *  
   486  *  This function is thread-safe.
   487  */
   488 extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
   489                                            SDL_eventaction action,
   490                                            Uint32 minType, Uint32 maxType);
   491 /*@}*/
   492 
   493 /**
   494  *  Checks to see if certain event types are in the event queue.
   495  */
   496 extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 type);
   497 extern DECLSPEC SDL_bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType);
   498 
   499 /**
   500  *  This function clears events from the event queue
   501  */
   502 extern DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type);
   503 extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
   504 
   505 /**
   506  *  \brief Polls for currently pending events.
   507  *  
   508  *  \return 1 if there are any pending events, or 0 if there are none available.
   509  *  
   510  *  \param event If not NULL, the next event is removed from the queue and 
   511  *               stored in that area.
   512  */
   513 extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
   514 
   515 /**
   516  *  \brief Waits indefinitely for the next available event.
   517  *  
   518  *  \return 1, or 0 if there was an error while waiting for events.
   519  *   
   520  *  \param event If not NULL, the next event is removed from the queue and 
   521  *               stored in that area.
   522  */
   523 extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
   524 
   525 /**
   526  *  \brief Waits until the specified timeout (in milliseconds) for the next 
   527  *         available event.
   528  *  
   529  *  \return 1, or 0 if there was an error while waiting for events.
   530  *  
   531  *  \param event If not NULL, the next event is removed from the queue and 
   532  *               stored in that area.
   533  */
   534 extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
   535                                                  int timeout);
   536 
   537 /**
   538  *  \brief Add an event to the event queue.
   539  *  
   540  *  \return 1 on success, 0 if the event was filtered, or -1 if the event queue 
   541  *          was full or there was some other error.
   542  */
   543 extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
   544 
   545 typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
   546 
   547 /**
   548  *  Sets up a filter to process all events before they change internal state and
   549  *  are posted to the internal event queue.
   550  *  
   551  *  The filter is protypted as:
   552  *  \code
   553  *      int SDL_EventFilter(void *userdata, SDL_Event * event);
   554  *  \endcode
   555  *
   556  *  If the filter returns 1, then the event will be added to the internal queue.
   557  *  If it returns 0, then the event will be dropped from the queue, but the 
   558  *  internal state will still be updated.  This allows selective filtering of
   559  *  dynamically arriving events.
   560  *  
   561  *  \warning  Be very careful of what you do in the event filter function, as 
   562  *            it may run in a different thread!
   563  *  
   564  *  There is one caveat when dealing with the ::SDL_QUITEVENT event type.  The
   565  *  event filter is only called when the window manager desires to close the
   566  *  application window.  If the event filter returns 1, then the window will
   567  *  be closed, otherwise the window will remain open if possible.
   568  *
   569  *  If the quit event is generated by an interrupt signal, it will bypass the
   570  *  internal queue and be delivered to the application at the next event poll.
   571  */
   572 extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
   573                                                 void *userdata);
   574 
   575 /**
   576  *  Return the current event filter - can be used to "chain" filters.
   577  *  If there is no event filter set, this function returns SDL_FALSE.
   578  */
   579 extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
   580                                                     void **userdata);
   581 
   582 /**
   583  *  Run the filter function on the current event queue, removing any
   584  *  events for which the filter returns 0.
   585  */
   586 extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter,
   587                                               void *userdata);
   588 
   589 /*@{*/
   590 #define SDL_QUERY	-1
   591 #define SDL_IGNORE	 0
   592 #define SDL_DISABLE	 0
   593 #define SDL_ENABLE	 1
   594 
   595 /**
   596  *  This function allows you to set the state of processing certain events.
   597  *   - If \c state is set to ::SDL_IGNORE, that event will be automatically 
   598  *     dropped from the event queue and will not event be filtered.
   599  *   - If \c state is set to ::SDL_ENABLE, that event will be processed 
   600  *     normally.
   601  *   - If \c state is set to ::SDL_QUERY, SDL_EventState() will return the 
   602  *     current processing state of the specified event.
   603  */
   604 extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint32 type, int state);
   605 /*@}*/
   606 #define SDL_GetEventState(type) SDL_EventState(type, SDL_QUERY)
   607 
   608 /**
   609  *  This function allocates a set of user-defined events, and returns
   610  *  the beginning event number for that set of events.
   611  *
   612  *  If there aren't enough user-defined events left, this function
   613  *  returns (Uint32)-1
   614  */
   615 extern DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
   616 
   617 /* Ends C function definitions when using C++ */
   618 #ifdef __cplusplus
   619 /* *INDENT-OFF* */
   620 }
   621 /* *INDENT-ON* */
   622 #endif
   623 #include "close_code.h"
   624 
   625 #endif /* _SDL_events_h */
   626 
   627 /* vi: set ts=4 sw=4 expandtab: */