diff --git a/GB_rewind_pop.md b/GB_rewind_pop.md index 8e1ab59..69d581e 100644 --- a/GB_rewind_pop.md +++ b/GB_rewind_pop.md @@ -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]] +