NAME¶

SDL_OpenStorage - Opens up a container using a client-provided storage interface.

SYNOPSIS¶

#include <SDL3/SDL_storage.h>

SDL_Storage * SDL_OpenStorage(const SDL_StorageInterface *iface, void *userdata);

DESCRIPTION¶

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().

This function makes a copy of iface and the caller does not need to keep it around after this call.

FUNCTION PARAMETERS¶

iface

the interface that implements this storage, initialized using SDL_INIT_INTERFACE().

userdata

the pointer that will be passed to the interface functions.

RETURN VALUE¶

Returns a storage container on success or NULL on failure; call SDL_GetError() for more information.

AVAILABILITY¶

This function is available since SDL 3.2.0.

SEE ALSO¶

SDL_CloseStorage(3), SDL_GetStorageFileSize(3), SDL_GetStorageSpaceRemaining(3), SDL_INIT_INTERFACE(3), SDL_ReadStorageFile(3), SDL_StorageReady(3), SDL_WriteStorageFile(3)