/Users/hercules/trunk/SDL/include/SDL_events.h File Reference

#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_video.h"
#include "SDL_keyboard.h"
#include "SDL_mouse.h"
#include "SDL_joystick.h"
#include "SDL_quit.h"
#include "begin_code.h"
#include "close_code.h"

Go to the source code of this file.

Data Structures
struct	SDL_WindowEvent
	Window state change event data (event.window.*). More...
struct	SDL_KeyboardEvent
	Keyboard button event structure (event.key.*). More...
struct	SDL_TextEditingEvent
	Keyboard text editing event structure (event.edit.*). More...
struct	SDL_TextInputEvent
	Keyboard text input event structure (event.text.*). More...
struct	SDL_MouseMotionEvent
	Mouse motion event structure (event.motion.*). More...
struct	SDL_MouseButtonEvent
	Mouse button event structure (event.button.*). More...
struct	SDL_MouseWheelEvent
	Mouse wheel event structure (event.wheel.*). More...
struct	SDL_JoyAxisEvent
	Joystick axis motion event structure (event.jaxis.*). More...
struct	SDL_JoyBallEvent
	Joystick trackball motion event structure (event.jball.*). More...
struct	SDL_JoyHatEvent
	Joystick hat position change event structure (event.jhat.*). More...
struct	SDL_JoyButtonEvent
	Joystick button event structure (event.jbutton.*). More...
struct	SDL_QuitEvent
	The "quit requested" event. More...
struct	SDL_UserEvent
	A user-defined event type (event.user.*). More...
struct	SDL_SysWMEvent
	A video driver dependent system event (event.syswm.*). More...
struct	SDL_ProximityEvent
struct	SDL_ActiveEvent
struct	SDL_ResizeEvent
union	SDL_Event
	General event structure. More...
Defines
#define	SDL_RELEASED   0
#define	SDL_PRESSED   1
#define	SDL_EVENTMASK(X)   (1<<(X))
#define	SDL_ALLEVENTS   0xFFFFFFFF
#define	SDL_TEXTEDITINGEVENT_TEXT_SIZE   (32)
#define	SDL_TEXTINPUTEVENT_TEXT_SIZE   (32)
#define	SDL_QUERY   -1
#define	SDL_IGNORE   0
#define	SDL_DISABLE   0
#define	SDL_ENABLE   1
Typedefs
typedef struct SDL_SysWMmsg	SDL_SysWMmsg
typedef SDL_Event *	event
Enumerations
enum	SDL_EventType {   SDL_NOEVENT = 0, SDL_WINDOWEVENT, SDL_KEYDOWN, SDL_KEYUP,   SDL_TEXTEDITING, SDL_TEXTINPUT, SDL_MOUSEMOTION, SDL_MOUSEBUTTONDOWN,   SDL_MOUSEBUTTONUP, SDL_MOUSEWHEEL, SDL_JOYAXISMOTION, SDL_JOYBALLMOTION,   SDL_JOYHATMOTION, SDL_JOYBUTTONDOWN, SDL_JOYBUTTONUP, SDL_QUIT,   SDL_SYSWMEVENT, SDL_PROXIMITYIN, SDL_PROXIMITYOUT, SDL_EVENT_RESERVED1,   SDL_EVENT_RESERVED2, SDL_EVENT_RESERVED3, SDL_USEREVENT = 24, SDL_NUMEVENTS = 32 }
	The types of events that can be delivered. More...
enum	SDL_EventMask {   SDL_WINDOWEVENTMASK = SDL_EVENTMASK(SDL_WINDOWEVENT), SDL_KEYDOWNMASK = SDL_EVENTMASK(SDL_KEYDOWN), SDL_KEYUPMASK = SDL_EVENTMASK(SDL_KEYUP), SDL_KEYEVENTMASK = SDL_EVENTMASK(SDL_KEYDOWN) | SDL_EVENTMASK(SDL_KEYUP),   SDL_TEXTEDITINGMASK = SDL_EVENTMASK(SDL_TEXTEDITING), SDL_TEXTINPUTMASK = SDL_EVENTMASK(SDL_TEXTINPUT), SDL_MOUSEMOTIONMASK = SDL_EVENTMASK(SDL_MOUSEMOTION), SDL_MOUSEBUTTONDOWNMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN),   SDL_MOUSEBUTTONUPMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONUP), SDL_MOUSEWHEELMASK = SDL_EVENTMASK(SDL_MOUSEWHEEL), SDL_MOUSEEVENTMASK, SDL_JOYAXISMOTIONMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION),   SDL_JOYBALLMOTIONMASK = SDL_EVENTMASK(SDL_JOYBALLMOTION), SDL_JOYHATMOTIONMASK = SDL_EVENTMASK(SDL_JOYHATMOTION), SDL_JOYBUTTONDOWNMASK = SDL_EVENTMASK(SDL_JOYBUTTONDOWN), SDL_JOYBUTTONUPMASK = SDL_EVENTMASK(SDL_JOYBUTTONUP),   SDL_JOYEVENTMASK, SDL_QUITMASK = SDL_EVENTMASK(SDL_QUIT), SDL_SYSWMEVENTMASK = SDL_EVENTMASK(SDL_SYSWMEVENT), SDL_PROXIMITYINMASK = SDL_EVENTMASK(SDL_PROXIMITYIN),   SDL_PROXIMITYOUTMASK = SDL_EVENTMASK(SDL_PROXIMITYOUT) }
	Predefined event masks.
enum	SDL_eventaction { SDL_ADDEVENT, SDL_PEEKEVENT, SDL_GETEVENT }
Functions
DECLSPEC void SDLCALL	SDL_PumpEvents (void)
DECLSPEC int SDLCALL	SDL_PeepEvents (SDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask)
DECLSPEC SDL_bool SDLCALL	SDL_HasEvent (Uint32 mask)
DECLSPEC int SDLCALL	SDL_PollEvent (SDL_Event *event)
DECLSPEC int SDLCALL	SDL_WaitEvent (SDL_Event *event)
DECLSPEC int SDLCALL	SDL_WaitEventTimeout (SDL_Event *event, int timeout)
DECLSPEC int SDLCALL	SDL_PushEvent (SDL_Event *event)
typedef	int (SDLCALL *SDL_EventFilter)(void *userdata
DECLSPEC void SDLCALL	SDL_SetEventFilter (SDL_EventFilter filter, void *userdata)
DECLSPEC SDL_bool SDLCALL	SDL_GetEventFilter (SDL_EventFilter *filter, void **userdata)
DECLSPEC void SDLCALL	SDL_FilterEvents (SDL_EventFilter filter, void *userdata)
DECLSPEC Uint8 SDLCALL	SDL_EventState (Uint8 type, int state)

---

Detailed Description

Include file for SDL event handling

---

Enumeration Type Documentation

enum SDL_EventType

The types of events that can be delivered.

Enumerator:

SDL_NOEVENT	Unused (do not remove)
SDL_WINDOWEVENT	Window state change
SDL_KEYDOWN	Keys pressed
SDL_KEYUP	Keys released
SDL_TEXTEDITING	Keyboard text editing (composition)
SDL_TEXTINPUT	Keyboard text input
SDL_MOUSEMOTION	Mouse moved
SDL_MOUSEBUTTONDOWN	Mouse button pressed
SDL_MOUSEBUTTONUP	Mouse button released
SDL_MOUSEWHEEL	Mouse wheel motion
SDL_JOYAXISMOTION	Joystick axis motion
SDL_JOYBALLMOTION	Joystick trackball motion
SDL_JOYHATMOTION	Joystick hat position change
SDL_JOYBUTTONDOWN	Joystick button pressed
SDL_JOYBUTTONUP	Joystick button released
SDL_QUIT	User-requested quit
SDL_SYSWMEVENT	System specific event
SDL_PROXIMITYIN	Proximity In event
SDL_PROXIMITYOUT	Proximity Out event
SDL_EVENT_RESERVED1	Reserved for future use...