SDL_StorageReady(3)

SDL_StorageReady3

Checks if the storage container is ready to use.

Usage

#include "SDL3/SDL.h"

bool SDL_StorageReady(SDL_Storage *storage);

Header file

Defined in SDL3/SDL_storage.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.