SDL_ReadStorageFile(3)

SDL_ReadStorageFile3

Synchronously read a file from a storage container into a client-provided buffer.

Usage

#include "SDL3/SDL.h"

bool SDL_ReadStorageFile(SDL_Storage *storage, const char *path, void *destination, Uint64 length);

Header file

Defined in SDL3/SDL_storage.h

Overview

The value of length must match the length of the file exactly; call

SDL_GetStorageFileSize () to get this value. This behavior may be relaxed in a future release.

Function parameters

storage

a storage container to read from.

path

the relative path of the file to read.

destination

a client-provided buffer to read the file into.

length

the length of the destination buffer.

Return value

Returns true if the file was read or false on failure; call

SDL_GetError () for more information.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.