SDL 2.0
|
Include file for filesystem SDL API functions. More...
Go to the source code of this file.
Functions | |
char * | SDL_GetBasePath (void) |
char * | SDL_GetPrefPath (const char *org, const char *app) |
Include file for filesystem SDL API functions.
Definition in file SDL_filesystem.h.
char * SDL_GetBasePath | ( | void | ) |
Get the directory where the application was run from.
This is not necessarily a fast call, so you should call this once near startup and save the string if you need it.
Mac OS X 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/
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).
The pointer returned is owned by the caller. Please call SDL_free() on the pointer when done with it.
char * SDL_GetPrefPath | ( | const char * | org, |
const char * | app | ||
) |
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 Mac OS X, 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:
The returned path is guaranteed to end with a path separator ('\' on Windows, '/' on most other platforms).
The pointer returned is owned by the caller. Please call SDL_free() on the pointer when done with it.
org | the name of your organization |
app | the name of your application |