Wiki Page Content

Differences between revisions 10 and 11
Revision 10 as of 2013-08-08 23:20:09
Size: 1223
Editor: RyanGordon
Comment: Note about polling
Revision 11 as of 2013-08-08 23:23:20
Size: 1235
Editor: RyanGordon
Comment: Style tweak
Deletions are marked like this. Additions are marked like this.
Line 26: Line 26:
If event is not NULL, the next event is removed from the queue and stored in the SDL_Event structure pointed to by event. If '''event''' is not NULL, the next event is removed from the queue and stored in the SDL_Event structure pointed to by '''event'''.

SDL_WaitEvent

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

Syntax

int SDL_WaitEvent(SDL_Event* event)

Function Parameters

event

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

Remarks

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 set the video mode.

As of SDL 2.0, this function does not put the application's process to sleep waiting for events; it polls for events in a loop internally. This may change in the future to improve power savings.


CategoryAPI, CategoryEvents

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

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