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

Function SDL_DestroyAsyncIOQueue

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

Destroy a previously-created async I/O task queue.

If there are still tasks pending for this queue, this call will block until those tasks are finished. All those tasks will be deallocated. Their results will be lost to the app.

Any pending reads from SDL_LoadFileAsync() that are still in this queue will have their buffers deallocated by this function, to prevent a memory leak.

Once this function is called, the queue is no longer valid and should not be used, including by other threads that might access it while destruction is blocking on pending tasks.

Do not destroy a queue that still has threads waiting on it through SDL_WaitAsyncIOResult(). You can call SDL_SignalAsyncIOQueue() first to unblock those threads, and take measures (such as [SDL_WaitThread()]) to make sure they have finished their wait and won’t wait on the queue again.

§Parameters

  • queue: the task queue to destroy.

§Thread safety

It is safe to call this function from any thread, so long as no other thread is waiting on the queue with SDL_WaitAsyncIOResult.

§Availability

This function is available since SDL 3.2.0.