Browse Source

Clarify the expected usage of SDL_StorageReady()

Fixes https://github.com/libsdl-org/SDL/issues/12201
Sam Lantinga 1 month ago
parent
commit
ac5fca4ae5
1 changed files with 1 additions and 1 deletions
  1. 1 1
      include/SDL3/SDL_storage.h

+ 1 - 1
include/SDL3/SDL_storage.h

@@ -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 -
  * 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.
  * \returns true if the container is ready, false otherwise.