plucky (3) SDL_WaitEvent.3.gz

NAME

       SDL_WaitEvent - Wait indefinitely for the next available event.

HEADER FILE

       Defined in SDL3/SDL_events.h

SYNOPSIS

       #include "SDL3/SDL.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

       Returns true on success or false if there was an error while waiting for events; call SDL_GetError () 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

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