waitTimeout method

bool waitTimeout(int timeout)

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

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.

\param event the SDL_Event structure to be filled in with the next event from the queue, or NULL. \param timeoutMS the maximum number of milliseconds to wait for the next available event. \returns true if this got an event or false if the timeout elapsed without any events available.

\threadsafety This function should only be called on the main thread.

\since This function is available since SDL 3.1.3.

\sa SDL_PollEvent \sa SDL_PushEvent \sa SDL_WaitEvent

extern SDL_DECLSPEC bool SDLCALL SDL_WaitEventTimeout(SDL_Event *event, Sint32 timeoutMS)

Implementation

bool waitTimeout(int timeout) {
  return sdlWaitEventTimeout(this, timeout);
}