Updated GB_load_boot_rom (markdown)

Lior Halphon 2024-11-25 00:02:19 +02:00
parent b63f60d33a
commit 6c5a0d508f
1 changed files with 8 additions and 1 deletions

@ -6,8 +6,15 @@ In `gb.h`
## Description ## Description
TBD Loads a boot ROM from a file into an emulator instance. Returns 0 on success, a positive `errno` value on a POSIX failure, and `-1` on other failures. If you're not using [[GB_set_boot_rom_load_callback]], this function (or [[GB_load_boot_rom_from_buffer]]) must be called with a boot ROM compatible with the currently selected [[model|GB_model_t]] before [[running|GB_run]] the instance.
In case of a failure, an error message will also be output to the [[log|GB_set_log_callback]].
## Thread Safety ## Thread Safety
`GB_load_boot_rom` is thread-safe and can be called from any thread and context. `GB_load_boot_rom` is thread-safe and can be called from any thread and context.
## See Also
* [[GB_set_boot_rom_load_callback]]
* [[GB_load_boot_rom_from_buffer]]