diff --git a/GB_load_battery.md b/GB_load_battery.md index 44f76d1..6037549 100644 --- a/GB_load_battery.md +++ b/GB_load_battery.md @@ -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]] \ No newline at end of file