devela::_dep::sdl3::sys::asyncio

Function SDL_SignalAsyncIOQueue

pub unsafe extern "C" fn SDL_SignalAsyncIOQueue(
    queue: *mut SDL_AsyncIOQueue,
)
Available on crate feature dep_sdl3 only.
Expand description

Wake up any threads that are blocking in SDL_WaitAsyncIOResult().

This will unblock any threads that are sleeping in a call to SDL_WaitAsyncIOResult for the specified queue, and cause them to return from that function.

This can be useful when destroying a queue to make sure nothing is touching it indefinitely. In this case, once this call completes, the caller should take measures to make sure any previously-blocked threads have returned from their wait and will not touch the queue again (perhaps by setting a flag to tell the threads to terminate and then using [SDL_WaitThread()] to make sure they’ve done so).

§Parameters

  • queue: the async I/O task queue to signal.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also