SDL 3.0
|
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_filesystem.h>
#include <SDL3/SDL_properties.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>
Go to the source code of this file.
Data Structures | |
struct | SDL_StorageInterface |
Typedefs | |
typedef struct SDL_Storage | SDL_Storage |
Include file for storage container SDL API functions
Definition in file SDL_storage.h.
typedef struct SDL_Storage SDL_Storage |
Definition at line 78 of file SDL_storage.h.
|
extern |
Closes and frees a storage container.
storage | a storage container to close |
|
extern |
Create a directory in a writable storage container.
storage | a storage container |
path | the path of the directory to create |
|
extern |
Enumerate a directory in a storage container.
storage | a storage container |
path | the path of the directory to enumerate |
callback | a function that is called for each entry in the directory |
userdata | a pointer that is passed to callback |
|
extern |
Query the size of a file within a storage container.
storage | a storage container to query |
path | the relative path of the file to query |
length | a pointer to be filled with the file's length |
|
extern |
Get information about a filesystem path in a storage container.
storage | a storage container |
path | the path to query |
info | a pointer filled in with information about the path, or NULL to check for the existence of a file |
|
extern |
Queries the remaining space in a storage container.
storage | a storage container to query |
|
extern |
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.
path | the base path prepended to all storage paths, or NULL for no base path |
|
extern |
Opens up a container using a client-provided storage interface.
Applications do not need to use this function unless they are providing their own SDL_Storage implementation. If you just need an SDL_Storage, you should use the built-in implementations in SDL, like SDL_OpenTitleStorage() or SDL_OpenUserStorage().
iface | the function table to be used by this container |
userdata | the pointer that will be passed to the store interface |
|
extern |
Opens up a read-only container for the application's filesystem.
override | a path to override the backend's default title root |
props | a property list that may contain backend-specific information |
|
extern |
Opens up a container for a user's unique read/write filesystem.
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. This allows the backend to properly batch file operations and flush them when the container has been closed; ensuring safe and optimal save I/O.
org | the name of your organization |
app | the name of your application |
props | a property list that may contain backend-specific information |
|
extern |
Synchronously read a file from a storage container into a client-provided buffer.
storage | a storage container to read from |
path | the relative path of the file to read |
destination | a client-provided buffer to read the file into |
length | the length of the destination buffer |
|
extern |
Remove a file or an empty directory in a writable storage container.
storage | a storage container |
path | the path of the directory to enumerate |
|
extern |
Rename a file or directory in a writable storage container.
storage | a storage container |
oldpath | the old path |
newpath | the new path |
|
extern |
Checks if the storage container is ready to use.
This function should be called in regular intervals until it returns SDL_TRUE - however, it is not recommended to spinwait on this call, as the backend may depend on a synchronous message loop.
storage | a storage container to query |
|
extern |
Synchronously write a file from client memory into a storage container.
storage | a storage container to write to |
path | the relative path of the file to write |
source | a client-provided buffer to write from |
length | the length of the source buffer |