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