Class SDL_Folder

java.lang.Object

club.doki7.sdl3.enumtype.SDL_Folder

public final class SDL_Folder
extends Object

The type of the OS-provided default folder for a specific purpose.

Note that the Trash folder isn't included here, because trashing files usually involves extra OS-specific functionality to remember the file's original location.

The folders supported per platform are:

	Windows	macOS/iOS	tvOS	Unix (XDG)	Haiku	Emscripten
HOME	X	X		X	X	X
DESKTOP	X	X		X	X
DOCUMENTS	X	X		X
DOWNLOADS	Vista+	X		X
MUSIC	X	X		X
PICTURES	X	X		X
PUBLICSHARE		X		X
SAVEDGAMES	Vista+
SCREENSHOTS	Vista+
TEMPLATES	X	X		X
VIDEOS	X	X*		X

Note that on macOS/iOS, the Videos folder is called "Movies".

Since: This enum is available since SDL 3.2.0.

See also:

• SDL_GetUserFolder

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COUNT
static final int	DESKTOP
static final int	DOCUMENTS
static final int	DOWNLOADS
static final int	HOME
static final int	MUSIC
static final int	PICTURES
static final int	PUBLICSHARE
static final int	SAVEDGAMES
static final int	SCREENSHOTS
static final int	TEMPLATES
static final int	VIDEOS

Method Summary

Modifier and Type	Method	Description
static String	explain(int value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HOME

public static final int HOME

See Also:

• Constant Field Values

DESKTOP

public static final int DESKTOP

See Also:

• Constant Field Values

DOCUMENTS

public static final int DOCUMENTS

See Also:

• Constant Field Values

DOWNLOADS

public static final int DOWNLOADS

See Also:

• Constant Field Values

MUSIC

public static final int MUSIC

See Also:

• Constant Field Values

PICTURES

public static final int PICTURES

See Also:

• Constant Field Values

PUBLICSHARE

public static final int PUBLICSHARE

See Also:

• Constant Field Values

SAVEDGAMES

public static final int SAVEDGAMES

See Also:

• Constant Field Values

SCREENSHOTS

public static final int SCREENSHOTS

See Also:

• Constant Field Values

TEMPLATES

public static final int TEMPLATES

See Also:

• Constant Field Values

VIDEOS

public static final int VIDEOS

See Also:

• Constant Field Values

COUNT

public static final int COUNT

See Also:

• Constant Field Values

Method Details

explain

public static String explain(@EnumType(SDL_Folder.class)
 int value)