devela::_dep::sdl3::sys::filesystem

Function SDL_GetPrefPath

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

Get the user-and-app-specific path where files can be written.

Get the “pref dir”. This is meant to be where users can write personal files (preferences and save games, etc) that are specific to your application. This directory is unique per user, per application.

This function will decide the appropriate location in the native filesystem, create the directory if necessary, and return a string of the absolute path to the directory in UTF-8 encoding.

On Windows, the string might look like:

C:\\Users\\bob\\AppData\\Roaming\\My Company\\My Program Name\\

On Linux, the string might look like:

/home/bob/.local/share/My Program Name/

On macOS, the string might look like:

/Users/bob/Library/Application Support/My Program Name/

You should assume the path returned by this function is the only safe place to write files (and that SDL_GetBasePath(), while it might be writable, or even the parent of the returned path, isn’t where you should be writing things).

Both the org and app strings may become part of a directory name, so please follow these rules:

  • Try to use the same org string (including case-sensitivity) for all your applications that use this function.
  • Always use a unique app string for each one, and make sure it never changes for an app once you’ve decided on it.
  • Unicode characters are legal, as long as they are UTF-8 encoded, but…
  • …only use letters, numbers, and spaces. Avoid punctuation like “Game Name 2: Bad Guy’s Revenge!” … “Game Name 2” is sufficient.

The returned path is guaranteed to end with a path separator (‘\’ on Windows, ‘/’ on most other platforms).

§Parameters

  • org: the name of your organization.
  • app: the name of your application.

§Return value

Returns a UTF-8 string of the user directory in platform-dependent notation. NULL if there’s a problem (creating directory failed, etc.). This should be freed with SDL_free() when it is no longer needed.

§Availability

This function is available since SDL 3.2.0.

§See also