Man page - sdl_signalasyncioqueue(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_SignalAsyncIOQueue

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
THREAD SAFETY
AVAILABILITY
SEE ALSO

NAME

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

HEADER FILE

Defined in SDL3/SDL_asyncio.h

SYNOPSIS

#include "SDL3/SDL.h"

void SDL_SignalAsyncIOQueue(SDL_AsyncIOQueue *queue);

DESCRIPTION

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).

FUNCTION 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.