include/SDL_events.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 06 Jul 2007 09:22:18 +0000
changeset 2152 003c1b5b07da
parent 2131 55c7932d1fdb
child 2300 c97ad1abe05b
permissions -rw-r--r--
Fixed bug #382

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