logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_WaitEventTimeout - Wait until the specified timeout (in milliseconds) for the next available event.

Availability

       This function is available since SDL 3.2.0.

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.

       The timeout is not guaranteed, the actual wait time could be longer due to system scheduling.

Function Parameters

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

       timeoutMS
              the maximum number of milliseconds to wait for the next available event.

Header File

       Defined in SDL3/SDL_events.h

Name

       SDL_WaitEventTimeout - Wait until the specified timeout (in milliseconds) for the next available event.

Return Value

       Returns true if this got an event or false if the timeout elapsed without any events available.

See Also

(3), SDL_PollEvent(3), (3), SDL_PushEvent(3), (3), SDL_WaitEvent(3)

Simple Directmedia Layer                           SDL 3.2.10                            SDL_WaitEventTimeout(3)

Synopsis

#include"SDL3/SDL.h"boolSDL_WaitEventTimeout(SDL_Event*event,Sint32timeoutMS);

Thread Safety

       This function should only be called on the main thread.

See Also