From 2e1705518b60b0d27307bd783225e6b3f194837b Mon Sep 17 00:00:00 2001 From: Lior Halphon Date: Sat, 30 Nov 2024 21:16:50 +0200 Subject: [PATCH] Updated GB_rewind_reset (markdown) --- GB_rewind_reset.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/GB_rewind_reset.md b/GB_rewind_reset.md index 3975ebc..b97a30b 100644 --- a/GB_rewind_reset.md +++ b/GB_rewind_reset.md @@ -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]] \ No newline at end of file