Updated GB_rewind_reset (markdown)

Lior Halphon 2024-11-30 21:16:50 +02:00
parent 99545c00fd
commit 2e1705518b
1 changed files with 10 additions and 1 deletions

@ -6,8 +6,17 @@ In `rewind.h`
## Description
TBD
Clears the current contents of the emulator instance's rewind buffer.
## Thread Safety
`GB_rewind_reset` must not be called if the instance is being run in another thread, but may be called from the current one (via a callback).
## Note
You should call this function after performing changes that invalidate the internal save states in the rewind buffer, such as hot-swapping into an incompatible ROM. This function can be implicitly called by other APIs if such change is detected.
## See Also
* [[GB_set_rewind_length]]
* [[GB_rewind_pop]]