devela::_dep::sdl3::sys::storage

Function SDL_ReadStorageFile

pub unsafe extern "C" fn SDL_ReadStorageFile(
    storage: *mut SDL_Storage,
    path: *const i8,
    destination: *mut c_void,
    length: u64,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

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

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.

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

§See also