mirror
/
SDL
mirror of https://github.com/libsdl-org/SDL.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-03-17 15:40:25 +00:00
parent 2f78e5f321
commit a206e1e3c0
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/SDL3/SDL_storage.h
View File

@ -104,8 +104,8 @@ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenTitleStorage(const char *override,
* *
* While title storage can generally be kept open throughout runtime, user * While title storage can generally be kept open throughout runtime, user
* storage should only be opened when the client is ready to read/write files. * storage should only be opened when the client is ready to read/write files.
* This allows the backend to properly batch file operations and flush them when * This allows the backend to properly batch file operations and flush them
* the container has been closed; ensuring safe and optimal save I/O. * when the container has been closed; ensuring safe and optimal save I/O.
* *
* \param org the name of your organization * \param org the name of your organization
* \param app the name of your application * \param app the name of your application
@ -129,10 +129,14 @@ extern DECLSPEC SDL_Storage *SDLCALL SDL_OpenUserStorage(const char *org, const
/** /**
* Opens up a container for local filesystem storage. * Opens up a container for local filesystem storage.
* *
* This is provided for development and tools. Portable applications should use SDL_OpenTitleStorage() for access to game data and SDL_OpenUserStorage() for access to user data. * This is provided for development and tools. Portable applications should
* use SDL_OpenTitleStorage() for access to game data and
* SDL_OpenUserStorage() for access to user data.
* *
* \param path the base path prepended to all storage paths, or NULL for no base path * \param path the base path prepended to all storage paths, or NULL for no
* \returns a filesystem storage container on success or NULL on failure; call SDL_GetError() for more information. * base path
* \returns a filesystem storage container on success or NULL on failure; call
* SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *