Provided by: libsdl3-doc_3.2.20+ds-2_all bug

NAME

       SDL_WaitEvent - Wait indefinitely for the next available event.

SYNOPSIS

       #include <SDL3/SDL_events.h>

       bool SDL_WaitEvent(SDL_Event *event);

DESCRIPTION

       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.

FUNCTION PARAMETERS

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

RETURN VALUE

       for more information.

THREAD SAFETY

       This function should only be called on the main thread.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       SDL_PollEvent(3), SDL_PushEvent(3), SDL_WaitEventTimeout(3)

Simple Directmedia Layer                           SDL 3.2.20                                   SDL_WaitEvent(3)