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

Function SDL_OpenUserStorage

pub unsafe extern "C" fn SDL_OpenUserStorage(
    org: *const i8,
    app: *const i8,
    props: u32,
) -> *mut SDL_Storage
Available on crate feature dep_sdl3 only.
Expand description

Opens up a container for a user’s unique read/write filesystem.

While title storage can generally be kept open throughout runtime, user storage should only be opened when the client is ready to read/write files. This allows the backend to properly batch file operations and flush them when the container has been closed; ensuring safe and optimal save I/O.

§Parameters

  • org: the name of your organization.
  • app: the name of your application.
  • props: a property list that may contain backend-specific information.

§Return value

Returns a user storage container on success or NULL on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.

§See also