include/SDL_events.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 31 Dec 2011 09:16:08 -0500
branchSDL-1.2
changeset 6137 4720145f848b
parent 4217 4c4113c2162c
permissions -rw-r--r--
Happy New Year!
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@6137
     3
    Copyright (C) 1997-2012 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@251
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@4217
    23
/**
slouken@4217
    24
 *  @file SDL_events.h
slouken@4217
    25
 *  Include file for SDL event handling
slouken@4217
    26
 */
slouken@0
    27
slouken@0
    28
#ifndef _SDL_events_h
slouken@0
    29
#define _SDL_events_h
slouken@0
    30
slouken@1356
    31
#include "SDL_stdinc.h"
slouken@1358
    32
#include "SDL_error.h"
slouken@0
    33
#include "SDL_active.h"
slouken@0
    34
#include "SDL_keyboard.h"
slouken@0
    35
#include "SDL_mouse.h"
slouken@0
    36
#include "SDL_joystick.h"
slouken@0
    37
#include "SDL_quit.h"
slouken@0
    38
slouken@0
    39
#include "begin_code.h"
slouken@0
    40
/* Set up for C function definitions, even when using C++ */
slouken@0
    41
#ifdef __cplusplus
slouken@0
    42
extern "C" {
slouken@0
    43
#endif
slouken@0
    44
slouken@4217
    45
/** @name General keyboard/mouse state definitions */
slouken@4217
    46
/*@{*/
slouken@1330
    47
#define SDL_RELEASED	0
slouken@1330
    48
#define SDL_PRESSED	1
slouken@4217
    49
/*@}*/
slouken@1330
    50
slouken@4217
    51
/** Event enumerations */
slouken@1294
    52
typedef enum {
slouken@4217
    53
       SDL_NOEVENT = 0,			/**< Unused (do not remove) */
slouken@4217
    54
       SDL_ACTIVEEVENT,			/**< Application loses/gains visibility */
slouken@4217
    55
       SDL_KEYDOWN,			/**< Keys pressed */
slouken@4217
    56
       SDL_KEYUP,			/**< Keys released */
slouken@4217
    57
       SDL_MOUSEMOTION,			/**< Mouse moved */
slouken@4217
    58
       SDL_MOUSEBUTTONDOWN,		/**< Mouse button pressed */
slouken@4217
    59
       SDL_MOUSEBUTTONUP,		/**< Mouse button released */
slouken@4217
    60
       SDL_JOYAXISMOTION,		/**< Joystick axis motion */
slouken@4217
    61
       SDL_JOYBALLMOTION,		/**< Joystick trackball motion */
slouken@4217
    62
       SDL_JOYHATMOTION,		/**< Joystick hat position change */
slouken@4217
    63
       SDL_JOYBUTTONDOWN,		/**< Joystick button pressed */
slouken@4217
    64
       SDL_JOYBUTTONUP,			/**< Joystick button released */
slouken@4217
    65
       SDL_QUIT,			/**< User-requested quit */
slouken@4217
    66
       SDL_SYSWMEVENT,			/**< System specific event */
slouken@4217
    67
       SDL_EVENT_RESERVEDA,		/**< Reserved for future use.. */
slouken@4217
    68
       SDL_EVENT_RESERVEDB,		/**< Reserved for future use.. */
slouken@4217
    69
       SDL_VIDEORESIZE,			/**< User resized video mode */
slouken@4217
    70
       SDL_VIDEOEXPOSE,			/**< Screen needs to be redrawn */
slouken@4217
    71
       SDL_EVENT_RESERVED2,		/**< Reserved for future use.. */
slouken@4217
    72
       SDL_EVENT_RESERVED3,		/**< Reserved for future use.. */
slouken@4217
    73
       SDL_EVENT_RESERVED4,		/**< Reserved for future use.. */
slouken@4217
    74
       SDL_EVENT_RESERVED5,		/**< Reserved for future use.. */
slouken@4217
    75
       SDL_EVENT_RESERVED6,		/**< Reserved for future use.. */
slouken@4217
    76
       SDL_EVENT_RESERVED7,		/**< Reserved for future use.. */
slouken@4217
    77
       /** Events SDL_USEREVENT through SDL_MAXEVENTS-1 are for your use */
slouken@0
    78
       SDL_USEREVENT = 24,
slouken@4217
    79
       /** This last event is only for bounding internal arrays
slouken@4217
    80
	*  It is the number of bits in the event mask datatype -- Uint32
slouken@0
    81
        */
slouken@0
    82
       SDL_NUMEVENTS = 32
slouken@1294
    83
} SDL_EventType;
slouken@0
    84
slouken@4217
    85
/** @name Predefined event masks */
slouken@4217
    86
/*@{*/
slouken@0
    87
#define SDL_EVENTMASK(X)	(1<<(X))
slouken@1294
    88
typedef enum {
slouken@0
    89
	SDL_ACTIVEEVENTMASK	= SDL_EVENTMASK(SDL_ACTIVEEVENT),
slouken@0
    90
	SDL_KEYDOWNMASK		= SDL_EVENTMASK(SDL_KEYDOWN),
slouken@0
    91
	SDL_KEYUPMASK		= SDL_EVENTMASK(SDL_KEYUP),
slouken@1297
    92
	SDL_KEYEVENTMASK	= SDL_EVENTMASK(SDL_KEYDOWN)|
slouken@1301
    93
	                          SDL_EVENTMASK(SDL_KEYUP),
slouken@0
    94
	SDL_MOUSEMOTIONMASK	= SDL_EVENTMASK(SDL_MOUSEMOTION),
slouken@0
    95
	SDL_MOUSEBUTTONDOWNMASK	= SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN),
slouken@0
    96
	SDL_MOUSEBUTTONUPMASK	= SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
slouken@0
    97
	SDL_MOUSEEVENTMASK	= SDL_EVENTMASK(SDL_MOUSEMOTION)|
slouken@0
    98
	                          SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN)|
slouken@0
    99
	                          SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
slouken@0
   100
	SDL_JOYAXISMOTIONMASK	= SDL_EVENTMASK(SDL_JOYAXISMOTION),
slouken@0
   101
	SDL_JOYBALLMOTIONMASK	= SDL_EVENTMASK(SDL_JOYBALLMOTION),
slouken@0
   102
	SDL_JOYHATMOTIONMASK	= SDL_EVENTMASK(SDL_JOYHATMOTION),
slouken@0
   103
	SDL_JOYBUTTONDOWNMASK	= SDL_EVENTMASK(SDL_JOYBUTTONDOWN),
slouken@0
   104
	SDL_JOYBUTTONUPMASK	= SDL_EVENTMASK(SDL_JOYBUTTONUP),
slouken@0
   105
	SDL_JOYEVENTMASK	= SDL_EVENTMASK(SDL_JOYAXISMOTION)|
slouken@0
   106
	                          SDL_EVENTMASK(SDL_JOYBALLMOTION)|
slouken@0
   107
	                          SDL_EVENTMASK(SDL_JOYHATMOTION)|
slouken@0
   108
	                          SDL_EVENTMASK(SDL_JOYBUTTONDOWN)|
slouken@0
   109
	                          SDL_EVENTMASK(SDL_JOYBUTTONUP),
slouken@0
   110
	SDL_VIDEORESIZEMASK	= SDL_EVENTMASK(SDL_VIDEORESIZE),
slouken@0
   111
	SDL_VIDEOEXPOSEMASK	= SDL_EVENTMASK(SDL_VIDEOEXPOSE),
slouken@0
   112
	SDL_QUITMASK		= SDL_EVENTMASK(SDL_QUIT),
slouken@0
   113
	SDL_SYSWMEVENTMASK	= SDL_EVENTMASK(SDL_SYSWMEVENT)
slouken@1294
   114
} SDL_EventMask ;
slouken@0
   115
#define SDL_ALLEVENTS		0xFFFFFFFF
slouken@4217
   116
/*@}*/
slouken@0
   117
slouken@4217
   118
/** Application visibility event structure */
slouken@911
   119
typedef struct SDL_ActiveEvent {
slouken@4217
   120
	Uint8 type;	/**< SDL_ACTIVEEVENT */
slouken@4217
   121
	Uint8 gain;	/**< Whether given states were gained or lost (1/0) */
slouken@4217
   122
	Uint8 state;	/**< A mask of the focus states */
slouken@0
   123
} SDL_ActiveEvent;
slouken@0
   124
slouken@4217
   125
/** Keyboard event structure */
slouken@911
   126
typedef struct SDL_KeyboardEvent {
slouken@4217
   127
	Uint8 type;	/**< SDL_KEYDOWN or SDL_KEYUP */
slouken@4217
   128
	Uint8 which;	/**< The keyboard device index */
slouken@4217
   129
	Uint8 state;	/**< SDL_PRESSED or SDL_RELEASED */
slouken@0
   130
	SDL_keysym keysym;
slouken@0
   131
} SDL_KeyboardEvent;
slouken@0
   132
slouken@4217
   133
/** Mouse motion event structure */
slouken@911
   134
typedef struct SDL_MouseMotionEvent {
slouken@4217
   135
	Uint8 type;	/**< SDL_MOUSEMOTION */
slouken@4217
   136
	Uint8 which;	/**< The mouse device index */
slouken@4217
   137
	Uint8 state;	/**< The current button state */
slouken@4217
   138
	Uint16 x, y;	/**< The X/Y coordinates of the mouse */
slouken@4217
   139
	Sint16 xrel;	/**< The relative motion in the X direction */
slouken@4217
   140
	Sint16 yrel;	/**< The relative motion in the Y direction */
slouken@0
   141
} SDL_MouseMotionEvent;
slouken@0
   142
slouken@4217
   143
/** Mouse button event structure */
slouken@911
   144
typedef struct SDL_MouseButtonEvent {
slouken@4217
   145
	Uint8 type;	/**< SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP */
slouken@4217
   146
	Uint8 which;	/**< The mouse device index */
slouken@4217
   147
	Uint8 button;	/**< The mouse button index */
slouken@4217
   148
	Uint8 state;	/**< SDL_PRESSED or SDL_RELEASED */
slouken@4217
   149
	Uint16 x, y;	/**< The X/Y coordinates of the mouse at press time */
slouken@0
   150
} SDL_MouseButtonEvent;
slouken@0
   151
slouken@4217
   152
/** Joystick axis motion event structure */
slouken@911
   153
typedef struct SDL_JoyAxisEvent {
slouken@4217
   154
	Uint8 type;	/**< SDL_JOYAXISMOTION */
slouken@4217
   155
	Uint8 which;	/**< The joystick device index */
slouken@4217
   156
	Uint8 axis;	/**< The joystick axis index */
slouken@4217
   157
	Sint16 value;	/**< The axis value (range: -32768 to 32767) */
slouken@0
   158
} SDL_JoyAxisEvent;
slouken@0
   159
slouken@4217
   160
/** Joystick trackball motion event structure */
slouken@911
   161
typedef struct SDL_JoyBallEvent {
slouken@4217
   162
	Uint8 type;	/**< SDL_JOYBALLMOTION */
slouken@4217
   163
	Uint8 which;	/**< The joystick device index */
slouken@4217
   164
	Uint8 ball;	/**< The joystick trackball index */
slouken@4217
   165
	Sint16 xrel;	/**< The relative motion in the X direction */
slouken@4217
   166
	Sint16 yrel;	/**< The relative motion in the Y direction */
slouken@0
   167
} SDL_JoyBallEvent;
slouken@0
   168
slouken@4217
   169
/** Joystick hat position change event structure */
slouken@911
   170
typedef struct SDL_JoyHatEvent {
slouken@4217
   171
	Uint8 type;	/**< SDL_JOYHATMOTION */
slouken@4217
   172
	Uint8 which;	/**< The joystick device index */
slouken@4217
   173
	Uint8 hat;	/**< The joystick hat index */
slouken@4217
   174
	Uint8 value;	/**< The hat position value:
slouken@4217
   175
			 *   SDL_HAT_LEFTUP   SDL_HAT_UP       SDL_HAT_RIGHTUP
slouken@4217
   176
			 *   SDL_HAT_LEFT     SDL_HAT_CENTERED SDL_HAT_RIGHT
slouken@4217
   177
			 *   SDL_HAT_LEFTDOWN SDL_HAT_DOWN     SDL_HAT_RIGHTDOWN
slouken@4217
   178
			 *  Note that zero means the POV is centered.
slouken@4217
   179
			 */
slouken@0
   180
} SDL_JoyHatEvent;
slouken@0
   181
slouken@4217
   182
/** Joystick button event structure */
slouken@911
   183
typedef struct SDL_JoyButtonEvent {
slouken@4217
   184
	Uint8 type;	/**< SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP */
slouken@4217
   185
	Uint8 which;	/**< The joystick device index */
slouken@4217
   186
	Uint8 button;	/**< The joystick button index */
slouken@4217
   187
	Uint8 state;	/**< SDL_PRESSED or SDL_RELEASED */
slouken@0
   188
} SDL_JoyButtonEvent;
slouken@0
   189
slouken@4217
   190
/** The "window resized" event
slouken@4217
   191
 *  When you get this event, you are responsible for setting a new video
slouken@4217
   192
 *  mode with the new width and height.
slouken@0
   193
 */
slouken@911
   194
typedef struct SDL_ResizeEvent {
slouken@4217
   195
	Uint8 type;	/**< SDL_VIDEORESIZE */
slouken@4217
   196
	int w;		/**< New width */
slouken@4217
   197
	int h;		/**< New height */
slouken@0
   198
} SDL_ResizeEvent;
slouken@0
   199
slouken@4217
   200
/** The "screen redraw" event */
slouken@911
   201
typedef struct SDL_ExposeEvent {
slouken@4217
   202
	Uint8 type;	/**< SDL_VIDEOEXPOSE */
slouken@0
   203
} SDL_ExposeEvent;
slouken@0
   204
slouken@4217
   205
/** The "quit requested" event */
slouken@911
   206
typedef struct SDL_QuitEvent {
slouken@4217
   207
	Uint8 type;	/**< SDL_QUIT */
slouken@0
   208
} SDL_QuitEvent;
slouken@0
   209
slouken@4217
   210
/** A user-defined event type */
slouken@911
   211
typedef struct SDL_UserEvent {
slouken@4217
   212
	Uint8 type;	/**< SDL_USEREVENT through SDL_NUMEVENTS-1 */
slouken@4217
   213
	int code;	/**< User defined event code */
slouken@4217
   214
	void *data1;	/**< User defined data pointer */
slouken@4217
   215
	void *data2;	/**< User defined data pointer */
slouken@0
   216
} SDL_UserEvent;
slouken@0
   217
slouken@4217
   218
/** If you want to use this event, you should include SDL_syswm.h */
slouken@0
   219
struct SDL_SysWMmsg;
slouken@0
   220
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
slouken@911
   221
typedef struct SDL_SysWMEvent {
slouken@0
   222
	Uint8 type;
slouken@0
   223
	SDL_SysWMmsg *msg;
slouken@0
   224
} SDL_SysWMEvent;
slouken@0
   225
slouken@4217
   226
/** General event structure */
slouken@1258
   227
typedef union SDL_Event {
slouken@0
   228
	Uint8 type;
slouken@0
   229
	SDL_ActiveEvent active;
slouken@0
   230
	SDL_KeyboardEvent key;
slouken@0
   231
	SDL_MouseMotionEvent motion;
slouken@0
   232
	SDL_MouseButtonEvent button;
slouken@0
   233
	SDL_JoyAxisEvent jaxis;
slouken@0
   234
	SDL_JoyBallEvent jball;
slouken@0
   235
	SDL_JoyHatEvent jhat;
slouken@0
   236
	SDL_JoyButtonEvent jbutton;
slouken@0
   237
	SDL_ResizeEvent resize;
slouken@0
   238
	SDL_ExposeEvent expose;
slouken@0
   239
	SDL_QuitEvent quit;
slouken@0
   240
	SDL_UserEvent user;
slouken@0
   241
	SDL_SysWMEvent syswm;
slouken@0
   242
} SDL_Event;
slouken@0
   243
slouken@0
   244
slouken@0
   245
/* Function prototypes */
slouken@0
   246
slouken@4217
   247
/** Pumps the event loop, gathering events from the input devices.
slouken@4217
   248
 *  This function updates the event queue and internal input device state.
slouken@4217
   249
 *  This should only be run in the thread that sets the video mode.
slouken@4217
   250
 */
slouken@337
   251
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
slouken@0
   252
slouken@0
   253
typedef enum {
slouken@0
   254
	SDL_ADDEVENT,
slouken@0
   255
	SDL_PEEKEVENT,
slouken@0
   256
	SDL_GETEVENT
slouken@0
   257
} SDL_eventaction;
slouken@4217
   258
slouken@4217
   259
/**
slouken@4217
   260
 *  Checks the event queue for messages and optionally returns them.
slouken@4217
   261
 *
slouken@4217
   262
 *  If 'action' is SDL_ADDEVENT, up to 'numevents' events will be added to
slouken@4217
   263
 *  the back of the event queue.
slouken@4217
   264
 *  If 'action' is SDL_PEEKEVENT, up to 'numevents' events at the front
slouken@4217
   265
 *  of the event queue, matching 'mask', will be returned and will not
slouken@4217
   266
 *  be removed from the queue.
slouken@4217
   267
 *  If 'action' is SDL_GETEVENT, up to 'numevents' events at the front 
slouken@4217
   268
 *  of the event queue, matching 'mask', will be returned and will be
slouken@4217
   269
 *  removed from the queue.
slouken@4217
   270
 *
slouken@4217
   271
 *  @return
slouken@4217
   272
 *  This function returns the number of events actually stored, or -1
slouken@4217
   273
 *  if there was an error.
slouken@4217
   274
 *
slouken@4217
   275
 *  This function is thread-safe.
slouken@4217
   276
 */
slouken@337
   277
extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event *events, int numevents,
slouken@0
   278
				SDL_eventaction action, Uint32 mask);
slouken@0
   279
slouken@4217
   280
/** Polls for currently pending events, and returns 1 if there are any pending
slouken@4217
   281
 *  events, or 0 if there are none available.  If 'event' is not NULL, the next
slouken@4217
   282
 *  event is removed from the queue and stored in that area.
slouken@0
   283
 */
slouken@337
   284
extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event *event);
slouken@0
   285
slouken@4217
   286
/** Waits indefinitely for the next available event, returning 1, or 0 if there
slouken@4217
   287
 *  was an error while waiting for events.  If 'event' is not NULL, the next
slouken@4217
   288
 *  event is removed from the queue and stored in that area.
slouken@0
   289
 */
slouken@337
   290
extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event *event);
slouken@0
   291
slouken@4217
   292
/** Add an event to the event queue.
slouken@4217
   293
 *  This function returns 0 on success, or -1 if the event queue was full
slouken@4217
   294
 *  or there was some other error.
slouken@0
   295
 */
slouken@337
   296
extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event *event);
slouken@0
   297
slouken@4217
   298
/** @name Event Filtering */
slouken@4217
   299
/*@{*/
slouken@930
   300
typedef int (SDLCALL *SDL_EventFilter)(const SDL_Event *event);
slouken@4217
   301
/**
slouken@4217
   302
 *  This function sets up a filter to process all events before they
slouken@4217
   303
 *  change internal state and are posted to the internal event queue.
slouken@4217
   304
 *
slouken@4217
   305
 *  The filter is protypted as:
slouken@4217
   306
 *      @code typedef int (SDLCALL *SDL_EventFilter)(const SDL_Event *event); @endcode
slouken@4217
   307
 *
slouken@4217
   308
 * If the filter returns 1, then the event will be added to the internal queue.
slouken@4217
   309
 * If it returns 0, then the event will be dropped from the queue, but the 
slouken@4217
   310
 * internal state will still be updated.  This allows selective filtering of
slouken@4217
   311
 * dynamically arriving events.
slouken@4217
   312
 *
slouken@4217
   313
 * @warning  Be very careful of what you do in the event filter function, as 
slouken@4217
   314
 *           it may run in a different thread!
slouken@4217
   315
 *
slouken@4217
   316
 * There is one caveat when dealing with the SDL_QUITEVENT event type.  The
slouken@4217
   317
 * event filter is only called when the window manager desires to close the
slouken@4217
   318
 * application window.  If the event filter returns 1, then the window will
slouken@4217
   319
 * be closed, otherwise the window will remain open if possible.
slouken@4217
   320
 * If the quit event is generated by an interrupt signal, it will bypass the
slouken@4217
   321
 * internal queue and be delivered to the application at the next event poll.
slouken@4217
   322
 */
slouken@337
   323
extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter);
slouken@0
   324
slouken@4217
   325
/**
slouken@4217
   326
 *  Return the current event filter - can be used to "chain" filters.
slouken@4217
   327
 *  If there is no event filter set, this function returns NULL.
slouken@4217
   328
 */
slouken@337
   329
extern DECLSPEC SDL_EventFilter SDLCALL SDL_GetEventFilter(void);
slouken@4217
   330
/*@}*/
slouken@0
   331
slouken@4217
   332
/** @name Event State */
slouken@4217
   333
/*@{*/
slouken@0
   334
#define SDL_QUERY	-1
slouken@0
   335
#define SDL_IGNORE	 0
slouken@0
   336
#define SDL_DISABLE	 0
slouken@0
   337
#define SDL_ENABLE	 1
slouken@4217
   338
/*@}*/
slouken@4217
   339
slouken@4217
   340
/**
slouken@4217
   341
* This function allows you to set the state of processing certain events.
slouken@4217
   342
* If 'state' is set to SDL_IGNORE, that event will be automatically dropped
slouken@4217
   343
* from the event queue and will not event be filtered.
slouken@4217
   344
* If 'state' is set to SDL_ENABLE, that event will be processed normally.
slouken@4217
   345
* If 'state' is set to SDL_QUERY, SDL_EventState() will return the 
slouken@4217
   346
* current processing state of the specified event.
slouken@4217
   347
*/
slouken@337
   348
extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint8 type, int state);
slouken@0
   349
slouken@0
   350
/* Ends C function definitions when using C++ */
slouken@0
   351
#ifdef __cplusplus
slouken@0
   352
}
slouken@0
   353
#endif
slouken@0
   354
#include "close_code.h"
slouken@0
   355
slouken@0
   356
#endif /* _SDL_events_h */