SDL 3.0
SDL_StorageInterface Struct Reference

#include <SDL_storage.h>

Data Fields

SDL_bool(* close )(void *userdata)
 
SDL_bool(* ready )(void *userdata)
 
SDL_bool(* enumerate )(void *userdata, const char *path, SDL_EnumerateDirectoryCallback callback, void *callback_userdata)
 
SDL_bool(* info )(void *userdata, const char *path, SDL_PathInfo *info)
 
SDL_bool(* read_file )(void *userdata, const char *path, void *destination, Uint64 length)
 
SDL_bool(* write_file )(void *userdata, const char *path, const void *source, Uint64 length)
 
SDL_bool(* mkdir )(void *userdata, const char *path)
 
SDL_bool(* remove )(void *userdata, const char *path)
 
SDL_bool(* rename )(void *userdata, const char *oldpath, const char *newpath)
 
SDL_bool(* copy )(void *userdata, const char *oldpath, const char *newpath)
 
Uint64(* space_remaining )(void *userdata)
 

Detailed Description

CategoryStorage

SDL storage container management. 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.

Definition at line 57 of file SDL_storage.h.

Field Documentation

◆ close

SDL_bool(* SDL_StorageInterface::close) (void *userdata)

Definition at line 60 of file SDL_storage.h.

◆ copy

SDL_bool(* SDL_StorageInterface::copy) (void *userdata, const char *oldpath, const char *newpath)

Definition at line 87 of file SDL_storage.h.

◆ enumerate

SDL_bool(* SDL_StorageInterface::enumerate) (void *userdata, const char *path, SDL_EnumerateDirectoryCallback callback, void *callback_userdata)

Definition at line 66 of file SDL_storage.h.

◆ info

SDL_bool(* SDL_StorageInterface::info) (void *userdata, const char *path, SDL_PathInfo *info)

Definition at line 69 of file SDL_storage.h.

◆ mkdir

SDL_bool(* SDL_StorageInterface::mkdir) (void *userdata, const char *path)

Definition at line 78 of file SDL_storage.h.

◆ read_file

SDL_bool(* SDL_StorageInterface::read_file) (void *userdata, const char *path, void *destination, Uint64 length)

Definition at line 72 of file SDL_storage.h.

◆ ready

SDL_bool(* SDL_StorageInterface::ready) (void *userdata)

Definition at line 63 of file SDL_storage.h.

◆ remove

SDL_bool(* SDL_StorageInterface::remove) (void *userdata, const char *path)

Definition at line 81 of file SDL_storage.h.

◆ rename

SDL_bool(* SDL_StorageInterface::rename) (void *userdata, const char *oldpath, const char *newpath)

Definition at line 84 of file SDL_storage.h.

◆ space_remaining

Uint64(* SDL_StorageInterface::space_remaining) (void *userdata)

Definition at line 90 of file SDL_storage.h.

◆ write_file

SDL_bool(* SDL_StorageInterface::write_file) (void *userdata, const char *path, const void *source, Uint64 length)

Definition at line 75 of file SDL_storage.h.


The documentation for this struct was generated from the following file: