Updated GB_rewind_pop (markdown)

Lior Halphon 2024-11-30 21:11:12 +02:00
parent 1c519cd6fb
commit 99545c00fd
1 changed files with 11 additions and 1 deletions

@ -6,8 +6,18 @@ In `rewind.h`
## Description
TBD
Rewinds the emulator instance one frame backwards. Returns `false` if the end of the rewind buffer was reached, and `true` otherwise.
## Thread Safety
`GB_rewind_pop` must not be called if the instance is being run in any thread, including the current one (via a callback).
## Notes
Rewinding a frame will not re-render the popped frame or call the [[vblank callback|GB_set_vblank_callback]]. To obtain the audio-visual output of the rewound frame, call `GB_rewind_pop` one more time, then run the emulator instance for a single frame (e.g. using [[GB_run_frame]]) to let the outputs render.
## See Also
* [[GB_set_rewind_length]]
* [[GB_rewind_reset]]