From 6c5a0d508f98df9f0e33f029ba600a00523bf81e Mon Sep 17 00:00:00 2001 From: Lior Halphon Date: Mon, 25 Nov 2024 00:02:19 +0200 Subject: [PATCH] Updated GB_load_boot_rom (markdown) --- GB_load_boot_rom.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/GB_load_boot_rom.md b/GB_load_boot_rom.md index 9a947df..09b6da8 100644 --- a/GB_load_boot_rom.md +++ b/GB_load_boot_rom.md @@ -6,8 +6,15 @@ In `gb.h` ## 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 `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]]