SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_WaitEventTimeout

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

Syntax

SDL_bool SDL_WaitEventTimeout(SDL_Event *event, Sint32 timeoutMS);

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

Return Value

Returns SDL_TRUE if this got an event or SDL_FALSE if the timeout elapsed without any events available.

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.

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

Version

This function is available since SDL 3.0.0.


CategoryAPI, CategoryEvents


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.