NAME

       SDL_ReadAsyncIO - Start an async read.

SYNOPSIS

       #include <SDL3/SDL_asyncio.h>

       bool SDL_ReadAsyncIO(SDL_AsyncIO *asyncio, void *ptr, Uint64 offset, Uint64 size, SDL_AsyncIOQueue *queue, void *userdata);

DESCRIPTION

       This  function  reads  up to size bytes from offset position in the data source to the area pointed at by
       ptr.  This function may read less bytes than requested.

       This function returns as quickly as possible; it does not wait for the read to complete. On a  successful
       return,  this  work  will continue in the background. If the work begins, even failure is asynchronous: a
       failing return value from this function only means the work couldn't start at all.

       ptr must remain available until the work is done, and may be accessed by the system  at  any  time  until
       then. Do not allocate it on the stack, as this might take longer than the life of the calling function to
       complete!

       An  SDL_AsyncIOQueue  must be specified. The newly-created task will be added to it when it completes its
       work.

FUNCTION PARAMETERS

       asyncio
              a pointer to an SDL_AsyncIO structure.

       ptr    a pointer to a buffer to read data into.

       offset the position to start reading in the data source.

       size   the number of bytes to read from the data source.

       queue  a queue to add the new SDL_AsyncIO to.

       userdata
              an app-defined pointer that will be provided with the task results.

RETURN VALUE

       for more information.

THREAD SAFETY

       It is safe to call this function from any thread.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       SDL_WriteAsyncIO(3), SDL_CreateAsyncIOQueue(3)

Simple Directmedia Layer                           SDL 3.2.26                                 SDL_ReadAsyncIO(3)