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