SDL_LoadFileAsync

Load all the data from a file path, asynchronously.

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.

The data is allocated with a zero byte at the end (null terminated) for convenience. This extra byte is not included in SDL_AsyncIOOutcome's bytes_transferred value.

This function will allocate the buffer to contain the file. It must be deallocated by calling SDL_free on SDL_AsyncIOOutcome's buffer field after completion.

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

extern (C) nothrow @nogc extern
bool
SDL_LoadFileAsync
(
const(char)* file
,,
void* userdata
)

Parameters

file const(char)*

the path to read all available data from.

queue SDL_AsyncIOQueue*

a queue to add the new SDL_AsyncIO to.

userdata void*

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

Return Value

Type: bool

true on success or false on failure; call SDL_GetError for more information.

See Also

SDL_LoadFile_IO

Meta

History

Available since SDL 3.2.0.