TeamHepta/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-03-20 15:51:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

include: Filled in some missing documentation.

Browse Source
This commit is contained in:
Ryan C. Gordon
2024-05-02 22:53:08 -04:00
parent 1c6ba2a9ab
commit 760d7d276b
5 changed files with 210 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
include/SDL3/SDL_storage.h
View File

@@ -42,6 +42,19 @@ extern "C" {
/* !!! FIXME: Don't let this ship without async R/W support!!! */
/**
* Function interface for SDL_Storage.
*
* Apps that want to supply a custom implementation of SDL_Storage
* will fill in all the functions in this struct, and then pass it to
* SDL_OpenStorage to create a custom SDL_Storage object.
*
* It is not usually necessary to do this; SDL provides standard
* implementations for many things you might expect to do with
* an SDL_Storage.
*
* \since This struct is available since SDL 3.0.0.
*/
typedef struct SDL_StorageInterface
{
/* Called when the storage is closed */
@@ -73,9 +86,18 @@ typedef struct SDL_StorageInterface
/* Get the space remaining, optional for read-only storage */
Uint64 (SDLCALL *space_remaining)(void *userdata);
} SDL_StorageInterface;
/**
* An abstract interface for filesystem access.
*
* This is an opaque datatype. One can create this object
* using standard SDL functions like SDL_OpenTitleStorage or
* SDL_OpenUserStorage, etc, or create an object with a custom
* implementation using SDL_OpenStorage.
*
* \since This struct is available since SDL 3.0.0.
*/
typedef struct SDL_Storage SDL_Storage;
/**