SDL_StorageReady - Man Page

Checks if the storage container is ready to use.

Header File

Defined in SDL3/SDL_storage.h

Synopsis

#include "SDL3/SDL.h"

bool SDL_StorageReady(SDL_Storage *storage);

Description

This function should be called in regular intervals until it returns true - however, it is not recommended to spinwait on this call, as the backend may depend on a synchronous message loop. You might instead poll this in your game's main loop while processing events and drawing a loading screen.

Function Parameters

storage

a storage container to query.

Return Value

Returns true if the container is ready, false otherwise.

Availability

This function is available since SDL 3.2.0.

Referenced By

SDL_CopyStorageFile(3), SDL_CreateStorageDirectory(3), SDL_EnumerateStorageDirectory(3), SDL_GetStorageFileSize(3), SDL_GetStoragePathInfo(3), SDL_GetStorageSpaceRemaining(3), SDL_OpenStorage(3), SDL_OpenUserStorage(3), SDL_ReadStorageFile(3), SDL_RemoveStoragePath(3), SDL_RenameStoragePath(3), SDL_WriteStorageFile(3).

SDL 3.2.8 Simple Directmedia Layer SDL3 FUNCTIONS