Man page - sdl_getuserfolder(3)

Packages contains this manual

Package:  libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:
• libsdl3-doc
• libsdl3-dev

Manual

SDL_GetUserFolder

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY

---

NAME

SDL_GetUserFolder - Finds the most suitable user folder for a specific purpose.

HEADER FILE

Defined in SDL3/SDL_filesystem.h

SYNOPSIS

#include "SDL3/SDL.h"

const char * SDL_GetUserFolder(SDL_Folder folder);

DESCRIPTION

Many OSes provide certain standard folders for certain purposes, such as storing pictures, music or videos for a certain user. This function gives the path for many of those special locations.

This function is specifically for _user_ folders, which are meant for the user to access and manage. For application-specific folders, meant to hold data for the application to manage, see

SDL_GetBasePath () and

SDL_GetPrefPath ().

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

If NULL is returned, the error may be obtained with

SDL_GetError ().

FUNCTION PARAMETERS

folder

the type of folder to find.

RETURN VALUE

Returns either a null-terminated C string containing the full path to the folder, or NULL if an error happened.

AVAILABILITY

This function is available since SDL 3.2.0.

---