Clarify the expected usage of SDL_StorageReady()

Fixes https://github.com/libsdl-org/SDL/issues/12201
This commit is contained in:
Sam Lantinga 2025-02-25 08:56:23 -08:00
parent fc365e945a
commit ac5fca4ae5
1 changed files with 1 additions and 1 deletions

View File

@ -450,7 +450,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CloseStorage(SDL_Storage *storage);
* *
* This function should be called in regular intervals until it returns true - * 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 * however, it is not recommended to spinwait on this call, as the backend may
* depend on a synchronous message loop. * 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.
* *
* \param storage a storage container to query. * \param storage a storage container to query.
* \returns true if the container is ready, false otherwise. * \returns true if the container is ready, false otherwise.