NAME

       SDL_GetAsyncIOResult - Query an async I/O task queue for completed tasks.

HEADER FILE

       Defined in SDL3/SDL_asyncio.h

SYNOPSIS

       #include "SDL3/SDL.h"

       bool SDL_GetAsyncIOResult(SDL_AsyncIOQueue *queue, SDL_AsyncIOOutcome *outcome);

DESCRIPTION

       If a task assigned to this queue has finished, this will return true and fill in outcome with the details
       of  the  task.  If no task in the queue has finished, this function will return false. This function does
       not block.

       If a task has completed, this function will free its resources and the task pointer  will  no  longer  be
       valid. The task will be removed from the queue.

       It  is  safe  for multiple threads to call this function on the same queue at once; a completed task will
       only go to one of the threads.

FUNCTION PARAMETERS

       queue  the async I/O task queue to query.

       outcome
              details of a finished task will be written here. May not be NULL.

RETURN VALUE

       Returns true if a task has completed, false otherwise.

THREAD SAFETY

       It is safe to call this function from any thread.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       •(3), SDL_WaitAsyncIOResult(3)

Simple Directmedia Layer                            SDL 3.2.8                            SDL_GetAsyncIOResult(3)