SDL
3.0
SDL_filesystem.h
Go to the documentation of this file.
1
/*
2
Simple DirectMedia Layer
3
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
4
5
This software is provided 'as-is', without any express or implied
6
warranty. In no event will the authors be held liable for any damages
7
arising from the use of this software.
8
9
Permission is granted to anyone to use this software for any purpose,
10
including commercial applications, and to alter it and redistribute it
11
freely, subject to the following restrictions:
12
13
1. The origin of this software must not be misrepresented; you must not
14
claim that you wrote the original software. If you use this software
15
in a product, an acknowledgment in the product documentation would be
16
appreciated but is not required.
17
2. Altered source versions must be plainly marked as such, and must not be
18
misrepresented as being the original software.
19
3. This notice may not be removed or altered from any source distribution.
20
*/
21
22
/**
23
* \file SDL_filesystem.h
24
*
25
* \brief Include file for filesystem SDL API functions
26
*/
27
28
#ifndef SDL_filesystem_h_
29
#define SDL_filesystem_h_
30
31
#include <
SDL3/SDL_stdinc.h
>
32
33
#include <
SDL3/SDL_begin_code.h
>
34
35
/* Set up for C function definitions, even when using C++ */
36
#ifdef __cplusplus
37
extern
"C"
{
38
#endif
39
40
/**
41
* Get the directory where the application was run from.
42
*
43
* This is not necessarily a fast call, so you should call this once near
44
* startup and save the string if you need it.
45
*
46
* **macOS and iOS Specific Functionality**: If the application is in a ".app"
47
* bundle, this function returns the Resource directory (e.g.
48
* MyApp.app/Contents/Resources/). This behaviour can be overridden by adding
49
* a property to the Info.plist file. Adding a string key with the name
50
* SDL_FILESYSTEM_BASE_DIR_TYPE with a supported value will change the
51
* behaviour.
52
*
53
* Supported values for the SDL_FILESYSTEM_BASE_DIR_TYPE property (Given an
54
* application in /Applications/SDLApp/MyApp.app):
55
*
56
* - `resource`: bundle resource directory (the default). For example:
57
* `/Applications/SDLApp/MyApp.app/Contents/Resources`
58
* - `bundle`: the Bundle directory. For example:
59
* `/Applications/SDLApp/MyApp.app/`
60
* - `parent`: the containing directory of the bundle. For example:
61
* `/Applications/SDLApp/`
62
*
63
* **Nintendo 3DS Specific Functionality**: This function returns "romfs"
64
* directory of the application as it is uncommon to store resources outside
65
* the executable. As such it is not a writable directory.
66
*
67
* The returned path is guaranteed to end with a path separator ('\' on
68
* Windows, '/' on most other platforms).
69
*
70
* The pointer returned is owned by the caller. Please call SDL_free() on the
71
* pointer when done with it.
72
*
73
* \returns an absolute path in UTF-8 encoding to the application data
74
* directory. NULL will be returned on error or when the platform
75
* doesn't implement this functionality, call SDL_GetError() for more
76
* information.
77
*
78
* \since This function is available since SDL 3.0.0.
79
*
80
* \sa SDL_GetPrefPath
81
*/
82
extern
DECLSPEC
char
*SDLCALL
SDL_GetBasePath
(
void
);
83
84
/**
85
* Get the user-and-app-specific path where files can be written.
86
*
87
* Get the "pref dir". This is meant to be where users can write personal
88
* files (preferences and save games, etc) that are specific to your
89
* application. This directory is unique per user, per application.
90
*
91
* This function will decide the appropriate location in the native
92
* filesystem, create the directory if necessary, and return a string of the
93
* absolute path to the directory in UTF-8 encoding.
94
*
95
* On Windows, the string might look like:
96
*
97
* `C:\\Users\\bob\\AppData\\Roaming\\My Company\\My Program Name\\`
98
*
99
* On Linux, the string might look like:
100
*
101
* `/home/bob/.local/share/My Program Name/`
102
*
103
* On macOS, the string might look like:
104
*
105
* `/Users/bob/Library/Application Support/My Program Name/`
106
*
107
* You should assume the path returned by this function is the only safe place
108
* to write files (and that SDL_GetBasePath(), while it might be writable, or
109
* even the parent of the returned path, isn't where you should be writing
110
* things).
111
*
112
* Both the org and app strings may become part of a directory name, so please
113
* follow these rules:
114
*
115
* - Try to use the same org string (_including case-sensitivity_) for all
116
* your applications that use this function.
117
* - Always use a unique app string for each one, and make sure it never
118
* changes for an app once you've decided on it.
119
* - Unicode characters are legal, as long as it's UTF-8 encoded, but...
120
* - ...only use letters, numbers, and spaces. Avoid punctuation like "Game
121
* Name 2: Bad Guy's Revenge!" ... "Game Name 2" is sufficient.
122
*
123
* The returned path is guaranteed to end with a path separator ('\' on
124
* Windows, '/' on most other platforms).
125
*
126
* The pointer returned is owned by the caller. Please call SDL_free() on the
127
* pointer when done with it.
128
*
129
* \param org the name of your organization
130
* \param app the name of your application
131
* \returns a UTF-8 string of the user directory in platform-dependent
132
* notation. NULL if there's a problem (creating directory failed,
133
* etc.).
134
*
135
* \since This function is available since SDL 3.0.0.
136
*
137
* \sa SDL_GetBasePath
138
*/
139
extern
DECLSPEC
char
*SDLCALL
SDL_GetPrefPath
(
const
char
*org,
const
char
*app);
140
141
/**
142
* The type of the OS-provided default folder for a specific purpose.
143
*
144
* Note that the Trash folder isn't included here, because trashing files usually
145
* involves extra OS-specific functionality to remember the file's original
146
* location.
147
*
148
* The folders supported per platform are:
149
*
150
* | | Windows | macOS/iOS | tvOS | Unix (XDG) | Haiku | Emscripten |
151
* | ----------- | ------- | --------- | ---- | ---------- | ----- | ---------- |
152
* | HOME | X | X | | X | X | X |
153
* | DESKTOP | X | X | | X | X | |
154
* | DOCUMENTS | X | X | | X | | |
155
* | DOWNLOADS | Vista+ | X | | X | | |
156
* | MUSIC | X | X | | X | | |
157
* | PICTURES | X | X | | X | | |
158
* | PUBLICSHARE | | X | | X | | |
159
* | SAVEDGAMES | Vista+ | | | | | |
160
* | SCREENSHOTS | Vista+ | | | | | |
161
* | TEMPLATES | X | X | | X | | |
162
* | VIDEOS | X | X | | X | | |
163
*
164
* Note that on macOS/iOS, the Videos folder is called "Movies".
165
*
166
* \sa SDL_GetPath
167
*/
168
typedef
enum
169
{
170
/** The folder which contains all of the current user's data, preferences,
171
and documents. It usually contains most of the other folders. If a
172
requested folder does not exist, the home folder can be considered a safe
173
fallback to store a user's documents. */
174
SDL_FOLDER_HOME
,
175
/** The folder of files that are displayed on the desktop. Note that the
176
existence of a desktop folder does not guarantee that the system does
177
show icons on its desktop; certain GNU/Linux distros with a graphical
178
environment may not have desktop icons. */
179
SDL_FOLDER_DESKTOP
,
180
/** User document files, possibly application-specific. This is a good
181
place to save a user's projects. */
182
SDL_FOLDER_DOCUMENTS
,
183
/** Standard folder for user files downloaded from the internet. */
184
SDL_FOLDER_DOWNLOADS
,
185
/** Music files that can be played using a standard music player (mp3,
186
ogg...). */
187
SDL_FOLDER_MUSIC
,
188
/** Image files that can be displayed using a standard viewer (png,
189
jpg...). */
190
SDL_FOLDER_PICTURES
,
191
/** Files that are meant to be shared with other users on the same
192
computer. */
193
SDL_FOLDER_PUBLICSHARE
,
194
/** Save files for games. */
195
SDL_FOLDER_SAVEDGAMES
,
196
/** Application screenshots. */
197
SDL_FOLDER_SCREENSHOTS
,
198
/** Template files to be used when the user requests the desktop environment
199
to create a new file in a certain folder, such as "New Text File.txt".
200
Any file in the Templates folder can be used as a starting point for a
201
new file. */
202
SDL_FOLDER_TEMPLATES
,
203
/** Video files that can be played using a standard video player (mp4,
204
webm...). */
205
SDL_FOLDER_VIDEOS
206
}
SDL_Folder
;
207
208
/**
209
* Finds the most suitable OS-provided folder for @p folder, and returns its
210
* path in OS-specific notation.
211
*
212
* Many OSes provide certain standard folders for certain purposes, such as
213
* storing pictures, music or videos for a certain user. This function gives
214
* the path for many of those special locations.
215
*
216
* Note that the function is expensive, and should be called once at the
217
* beginning of the execution and kept for as long as needed.
218
*
219
* The returned value is owned by the caller and should be freed with
220
* SDL_free().
221
*
222
* If NULL is returned, the error may be obtained with SDL_GetError().
223
*
224
* \param folder The type of folder to find
225
* \returns Either a null-terminated C string containing the full path to the
226
* folder, or NULL if an error happened.
227
*
228
* \since This function is available since SDL 3.0.0.
229
*
230
* \sa SDL_Folder
231
*/
232
extern
DECLSPEC
char
*SDLCALL
SDL_GetPath
(
SDL_Folder
folder);
233
234
/* Ends C function definitions when using C++ */
235
#ifdef __cplusplus
236
}
237
#endif
238
#include <
SDL3/SDL_close_code.h
>
239
240
#endif
/* SDL_filesystem_h_ */
SDL_begin_code.h
SDL_close_code.h
SDL_Folder
SDL_Folder
Definition:
SDL_filesystem.h:169
SDL_FOLDER_DOCUMENTS
@ SDL_FOLDER_DOCUMENTS
Definition:
SDL_filesystem.h:182
SDL_FOLDER_TEMPLATES
@ SDL_FOLDER_TEMPLATES
Definition:
SDL_filesystem.h:202
SDL_FOLDER_DOWNLOADS
@ SDL_FOLDER_DOWNLOADS
Definition:
SDL_filesystem.h:184
SDL_FOLDER_HOME
@ SDL_FOLDER_HOME
Definition:
SDL_filesystem.h:174
SDL_FOLDER_SAVEDGAMES
@ SDL_FOLDER_SAVEDGAMES
Definition:
SDL_filesystem.h:195
SDL_FOLDER_DESKTOP
@ SDL_FOLDER_DESKTOP
Definition:
SDL_filesystem.h:179
SDL_FOLDER_PICTURES
@ SDL_FOLDER_PICTURES
Definition:
SDL_filesystem.h:190
SDL_FOLDER_PUBLICSHARE
@ SDL_FOLDER_PUBLICSHARE
Definition:
SDL_filesystem.h:193
SDL_FOLDER_SCREENSHOTS
@ SDL_FOLDER_SCREENSHOTS
Definition:
SDL_filesystem.h:197
SDL_FOLDER_VIDEOS
@ SDL_FOLDER_VIDEOS
Definition:
SDL_filesystem.h:205
SDL_FOLDER_MUSIC
@ SDL_FOLDER_MUSIC
Definition:
SDL_filesystem.h:187
SDL_GetPath
char * SDL_GetPath(SDL_Folder folder)
SDL_GetBasePath
char * SDL_GetBasePath(void)
SDL_GetPrefPath
char * SDL_GetPrefPath(const char *org, const char *app)
SDL_stdinc.h
This is a general header that includes C language support.
include
SDL3
SDL_filesystem.h
Generated by
1.9.4