Wiki Page Content

Differences between revisions 12 and 13
Revision 12 as of 2014-01-18 05:26:57
Size: 1050
Editor: Sam Lantinga
Comment: Removed old comment about power savings
Revision 13 as of 2015-04-26 18:50:55
Size: 1050
Comment: Sorted releated functions, see SGFunctions.
Deletions are marked like this. Additions are marked like this.
Line 31: Line 31:
Line 32: Line 33:


Use this function to wait indefinitely for the next available event.


int SDL_WaitEvent(SDL_Event* event)

Function Parameters


the SDL_Event structure to be filled in with the next event from the queue, or NULL

Return Value

Returns 1 on success or 0 if there was an error while waiting for events; call SDL_GetError() for more information.

Code Examples

You can add your code example here


If event is not NULL, the next event is removed from the queue and stored in the SDL_Event structure pointed to by event.

As this function implicitly calls SDL_PumpEvents(), you can only call this function in the thread that initialized the video subsystem.

CategoryAPI, CategoryEvents

None: SDL_WaitEvent (last edited 2015-04-26 18:50:55 by PhilippWiesemann)

Please include your contact information if you'd like to receive a reply.