(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_WaitEvent

Wait indefinitely for the next available event.

Header File

Syntax

bool SDL_WaitEvent(SDL_Event *event);

Function Parameters

SDL_Event *

event

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

Return Value

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

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 may implicitly call SDL_PumpEvents(), you can only call this function in the thread that initialized the video subsystem.

Thread Safety

This should only be run in the thread that initialized the video subsystem, and for extra safety, you should consider only doing those things on the main thread in any case.

Version

This function is available since SDL 3.1.3.