ShuriZma
/
SameBoy
mirror of https://github.com/LIJI32/SameBoy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated GB_load_state (markdown)

Lior Halphon 2024-11-29 14:27:20 +02:00
parent 11e7459c33
commit 8d094f4ae4
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
GB_load_state.md

@ -6,8 +6,19 @@ In `save_state.h`
## Description
TBD
Loads a snapshot of an emulation state of the emulator instance from `path`. Returns `0` on success, a positive `errno` value on POSIX failures, and `-1` on other failures. Detailed error messages will be written to the [[log|GB_set_log_callback]] on failure.
## Thread Safety
`GB_load_state` must not be called if the instance is being run in any thread, including the current one (via a callback).
## Notes
SameBoy follows the [BESS](https://github.com/LIJI32/SameBoy/blob/master/BESS.md) specification, and will load save states from other BESS-compliant emulators.
Loading a save state will fail if [[the save state's model|GB_get_state_model]] is from a different [[model family|GB_model_t]]. Loading a save state from a different model in the same model family will not change the current model in the emulator instance. If this behavior is not desired, call [[GB_switch_model_and_reset]] with [[the correct model|GB_get_state_model]] before loading the save state.
## See Also
* [[GB_load_state_from_buffer]]
* [[GB_save_state]]