Safe Haskell	None
Language	GHC2021

SDL3.Sys.Bindgen.Filesystem

Description

SDL offers an API for examining and manipulating the system's filesystem. This covers most things one would need to do with directories, except for actual file I/O (which is covered by CategoryIOStream and CategoryAsyncIO instead).

There are functions to answer necessary path questions:

Where is my app's data? SDL_GetBasePath().
Where can I safely write files? SDL_GetPrefPath().
Where are paths like Downloads, Desktop, Music? SDL_GetUserFolder().
What is this thing at this location? SDL_GetPathInfo().
What items live in this folder? SDL_EnumerateDirectory().
What items live in this folder by wildcard? SDL_GlobDirectory().
What is my current working directory? SDL_GetCurrentDirectory().

SDL also offers functions to manipulate the directory tree: renaming, removing, copying files. Get the directory where the application was run from.

SDL caches the result of this call internally, but the first call to this function is not necessarily fast, so plan accordingly.

macOS and iOS Specific Functionality: If the application is in a ".app" bundle, this function returns the Resource directory (e.g. MyApp.app/Contents/Resources/). This behaviour can be overridden by adding a property to the Info.plist file. Adding a string key with the name SDL_FILESYSTEM_BASE_DIR_TYPE with a supported value will change the behaviour.

Supported values for the SDL_FILESYSTEM_BASE_DIR_TYPE property (Given an application in /Applications/SDLApp/MyApp.app):

resource: bundle resource directory (the default). For example: /Applications/SDLApp/MyApp.app/Contents/Resources
bundle: the Bundle directory. For example: /Applications/SDLApp/MyApp.app/
parent: the containing directory of the bundle. For example: /Applications/SDLApp/

Android Specific Functionality: This function returns "./", which allows filesystem operations to use internal storage and the asset system.

Nintendo 3DS Specific Functionality: This function returns "romfs" directory of the application as it is uncommon to store resources outside the executable. As such it is not a writable directory.

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

Returns: an absolute path in UTF-8 encoding to the application data directory. NULL will be returned on error or when the platform doesn't implement this functionality, call SDL_GetError() for more information.
Thread safety: It is safe to call this function from any thread.
See also: sDL_GetPrefPath

Since: 3.2.0

Synopsis

newtype SDL_Folder = SDL_Folder {
- unwrap :: CUInt
}
pattern SDL_FOLDER_HOME :: SDL_Folder
pattern SDL_FOLDER_DESKTOP :: SDL_Folder
pattern SDL_FOLDER_DOCUMENTS :: SDL_Folder
pattern SDL_FOLDER_DOWNLOADS :: SDL_Folder
pattern SDL_FOLDER_MUSIC :: SDL_Folder
pattern SDL_FOLDER_PICTURES :: SDL_Folder
pattern SDL_FOLDER_PUBLICSHARE :: SDL_Folder
pattern SDL_FOLDER_SAVEDGAMES :: SDL_Folder
pattern SDL_FOLDER_SCREENSHOTS :: SDL_Folder
pattern SDL_FOLDER_TEMPLATES :: SDL_Folder
pattern SDL_FOLDER_VIDEOS :: SDL_Folder
pattern SDL_FOLDER_COUNT :: SDL_Folder
newtype SDL_PathType = SDL_PathType {
- unwrap :: CUInt
}
pattern SDL_PATHTYPE_NONE :: SDL_PathType
pattern SDL_PATHTYPE_FILE :: SDL_PathType
pattern SDL_PATHTYPE_DIRECTORY :: SDL_PathType
pattern SDL_PATHTYPE_OTHER :: SDL_PathType
data SDL_PathInfo = SDL_PathInfo {
- type' :: SDL_PathType
- size :: Uint64
- create_time :: SDL_Time
- modify_time :: SDL_Time
- access_time :: SDL_Time
}
newtype SDL_GlobFlags = SDL_GlobFlags {
- unwrap :: Uint32
}
sDL_GLOB_CASEINSENSITIVE :: CUInt
newtype SDL_EnumerationResult = SDL_EnumerationResult {
- unwrap :: CUInt
}
pattern SDL_ENUM_CONTINUE :: SDL_EnumerationResult
pattern SDL_ENUM_SUCCESS :: SDL_EnumerationResult
pattern SDL_ENUM_FAILURE :: SDL_EnumerationResult
newtype SDL_EnumerateDirectoryCallback_Aux = SDL_EnumerateDirectoryCallback_Aux {
- unwrap :: Ptr Void -> PtrConst CChar -> PtrConst CChar -> IO SDL_EnumerationResult
}
newtype SDL_EnumerateDirectoryCallback = SDL_EnumerateDirectoryCallback {
- unwrap :: FunPtr SDL_EnumerateDirectoryCallback_Aux
}

Documentation

newtype SDL_Folder Source #

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

DESKTOP

X

DOCUMENTS

X

DOWNLOADS

Vista+

X

MUSIC

X

PICTURES

X

PUBLICSHARE

X

SAVEDGAMES

Vista+

SCREENSHOTS

Vista+

TEMPLATES

X

VIDEOS

X

X*

X

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

See also: sDL_GetUserFolder
C declaration: enum SDL_Folder, defined at SDL3/SDL_filesystem.h 195:14

Since: 3.2.0

Constructors

SDL_Folder
Fields unwrap :: CUInt

Instances

Instances details

Storable SDL_Folder Source #

Instance details

SDL_EnumerateDirectoryCallback_Aux
Fields unwrap :: Ptr Void -> PtrConst CChar -> PtrConst CChar -> IO SDL_EnumerationResult

SDL_EnumerateDirectoryCallback
Fields unwrap :: FunPtr SDL_EnumerateDirectoryCallback_Aux