Updated GB_load_battery (markdown)

Lior Halphon 2024-11-29 13:47:54 +02:00
parent 70bd8edcab
commit a83ca16685
1 changed files with 10 additions and 1 deletions

@ -6,8 +6,17 @@ In `gb.h`
## Description
TBD
Loads battery-backed information (e.g. battery-powered cartridge RAM or Real Time Clock information) from the file at `path` into the emulator instance. Return `0` on success and a positive value for `POSIX` failures`.
## Thread Safety
`GB_load_battery` must not be called if the instance is being run in another thread, but may be called from the current one (via a callback).
## Notes
This function does not considered truncated files as failures. SameBoy battery saves are compatible with most other emulators and vice versa.
## See Also
* [[GB_load_battery_from_buffer]]
* [[GB_save_battery]]