Update documentation to reflect the recommended way SDL_StorageReady() should be used
#12400
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…()` should be used (addresses libsdl-org#12201)
slouken
reviewed
Feb 26, 2025
| * bool quit = false; | ||
| * while (!quit) { | ||
| * // This part is key: You must keep polling events when waiting on | ||
| * // storage to be ready (SDL_StorageReady() returns true). Events |
There was a problem hiding this comment.
Suggested change
| * // storage to be ready (SDL_StorageReady() returns true). Events | |
| * // storage to be ready (SDL_StorageReady() returns true). Event |
slouken
reviewed
Feb 26, 2025
| * | ||
| * // Game/graphics/sound/etc. logic here, only using data known to | ||
| * // already be valid right now. Logic would set readGameDataNow and/or | ||
| * // saveDataOp when needed, then could wait for them every logic tick |
There was a problem hiding this comment.
A single step of updating the game logic. In classical 60 FPS games, it'd be a single frame.
|
So this got much more complicated. We can create an article with the storage best practices, but is there a way to simplify this? |
|
Yeah, this needs to move to the wiki if it needs this much code. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The example code had to get a bit bigger, since demonstrating the proper usage pattern for
SDL_StorageReady()requires showing a main loop with the readiness checking inside.