SDL_events.h File Reference

Fields shared by every event.

Game controller axis motion event structure (event.caxis.

*)

Game controller button event structure (event.cbutton.

*)

Controller device event structure (event.cdevice.

*)

Dollar Gesture Event (event.dgesture.

*)

An event used to request a file open by the system (event.drop.

*) This event is disabled by default, you can enable it with SDL_EventState()

Note:

If you enable this event, you must free the filename in the event.

General event structure.

Joystick axis motion event structure (event.jaxis.

*)

Joystick trackball motion event structure (event.jball.

*)

Joystick button event structure (event.jbutton.

*)

Joystick device event structure (event.jdevice.

*)

Joystick hat position change event structure (event.jhat.

*)

Keyboard button event structure (event.key.

*)

Mouse button event structure (event.button.

*)

Mouse motion event structure (event.motion.

*)

Mouse wheel event structure (event.wheel.

*)

Multiple Finger Gesture Event (event.mgesture.

*)

OS Specific event.

The "quit requested" event.

A video driver dependent system event (event.syswm.

*) This event is disabled by default, you can enable it with SDL_EventState()

Note:

If you want to use this event, you should include SDL_syswm.h.

Keyboard text editing event structure (event.edit.

*)

Keyboard text input event structure (event.text.

*)

Touch finger event structure (event.tfinger.

*)

A user-defined event type (event.user.

*)

Window state change event data (event.window.

*)

The types of events that can be delivered.

Enumerator:

SDL_FIRSTEVENT	Unused (do not remove)
SDL_QUIT	User-requested quit.
SDL_APP_TERMINATING	The application is being terminated by the OS Called on iOS in applicationWillTerminate() Called on Android in onDestroy()
SDL_APP_LOWMEMORY	The application is low on memory, free memory if possible. Called on iOS in applicationDidReceiveMemoryWarning() Called on Android in onLowMemory()
SDL_APP_WILLENTERBACKGROUND	The application is about to enter the background Called on iOS in applicationWillResignActive() Called on Android in onPause()
SDL_APP_DIDENTERBACKGROUND	The application did enter the background and may not get CPU for some time Called on iOS in applicationDidEnterBackground() Called on Android in onPause()
SDL_APP_WILLENTERFOREGROUND	The application is about to enter the foreground Called on iOS in applicationWillEnterForeground() Called on Android in onResume()
SDL_APP_DIDENTERFOREGROUND	The application is now interactive Called on iOS in applicationDidBecomeActive() Called on Android in onResume()
SDL_WINDOWEVENT	Window state change.
SDL_SYSWMEVENT	System specific event.
SDL_KEYDOWN	Key pressed.
SDL_KEYUP	Key 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_JOYDEVICEADDED	A new joystick has been inserted into the system.
SDL_JOYDEVICEREMOVED	An opened joystick has been removed.
SDL_CONTROLLERAXISMOTION	Game controller axis motion.
SDL_CONTROLLERBUTTONDOWN	Game controller button pressed.
SDL_CONTROLLERBUTTONUP	Game controller button released.
SDL_CONTROLLERDEVICEADDED	A new Game controller has been inserted into the system.
SDL_CONTROLLERDEVICEREMOVED	An opened Game controller has been removed.
SDL_CONTROLLERDEVICEREMAPPED	The controller mapping was updated.
SDL_CLIPBOARDUPDATE	The clipboard changed.
SDL_DROPFILE	The system requests a file open.
SDL_RENDER_TARGETS_RESET	The render targets have been reset.
SDL_USEREVENT	Events SDL_USEREVENT through SDL_LASTEVENT are for your use, and should be allocated with SDL_RegisterEvents()
SDL_LASTEVENT	This last event is only for bounding internal arrays.

Definition at line 55 of file SDL_events.h.

The function passed to SDL_CreateThread().

It is passed a void* user context parameter and returns an int.

Add a function which is called when an event is added to the queue.

Remove an event watch function added with SDL_AddEventWatch()

This function allows you to set the state of processing certain events.

• If state is set to SDL_IGNORE, that event will be automatically dropped from the event queue and will not event be filtered.
• If state is set to SDL_ENABLE, that event will be processed normally.
• If state is set to SDL_QUERY, SDL_EventState() will return the current processing state of the specified event.

Run the filter function on the current event queue, removing any events for which the filter returns 0.

This function clears events from the event queue.

Return the current event filter - can be used to "chain" filters.

If there is no event filter set, this function returns SDL_FALSE.

Checks to see if certain event types are in the event queue.

Checks the event queue for messages and optionally returns them.

If action is SDL_ADDEVENT, up to numevents events will be added to the back of the event queue.

If action is SDL_PEEKEVENT, up to numevents events at the front of the event queue, within the specified minimum and maximum type, will be returned and will not be removed from the queue.

If action is SDL_GETEVENT, up to numevents events at the front of the event queue, within the specified minimum and maximum type, will be returned and will be removed from the queue.

Returns:

The number of events actually stored, or -1 if there was an error.

This function is thread-safe.

Polls for currently pending events.

Returns:

1 if there are any pending events, or 0 if there are none available.

Parameters:

event

If not NULL, the next event is removed from the queue and stored in that area.

Pumps the event loop, gathering events from the input devices.

This function updates the event queue and internal input device state.

This should only be run in the thread that sets the video mode.

Add an event to the event queue.

Returns:

1 on success, 0 if the event was filtered, or -1 if the event queue was full or there was some other error.

This function allocates a set of user-defined events, and returns the beginning event number for that set of events.

If there aren't enough user-defined events left, this function returns (Uint32)-1

Sets up a filter to process all events before they change internal state and are posted to the internal event queue.

The filter is prototyped as:

      int SDL_EventFilter(void *userdata, SDL_Event * event);

If the filter returns 1, then the event will be added to the internal queue. If it returns 0, then the event will be dropped from the queue, but the internal state will still be updated. This allows selective filtering of dynamically arriving events.

Warning:

Be very careful of what you do in the event filter function, as it may run in a different thread!

There is one caveat when dealing with the SDL_QuitEvent event type. The event filter is only called when the window manager desires to close the application window. If the event filter returns 1, then the window will be closed, otherwise the window will remain open if possible.

If the quit event is generated by an interrupt signal, it will bypass the internal queue and be delivered to the application at the next event poll.

Waits indefinitely for the next available event.

Returns:

1, or 0 if there was an error while waiting for events.

Parameters:

event

If not NULL, the next event is removed from the queue and stored in that area.

Waits until the specified timeout (in milliseconds) for the next available event.

Returns:

1, or 0 if there was an error while waiting for events.

Parameters:

event	If not NULL, the next event is removed from the queue and stored in that area.
timeout	The timeout (in milliseconds) to wait for next event.