Function SDL_WaitEvent

pub unsafe extern "C" fn SDL_WaitEvent(event: *mut SDL_Event) -> bool

Available on crate feature dep_sdl3 only.

Wait indefinitely 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.

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

• SDL_PollEvent
• SDL_PushEvent
• SDL_WaitEventTimeout