From b1a02bfd93f7a1bc667f00093ca4acbad85ef2c0 Mon Sep 17 00:00:00 2001 From: Lior Halphon Date: Wed, 27 Nov 2024 23:36:25 +0200 Subject: [PATCH] Updated GB_set_border_mode (markdown) --- GB_set_border_mode.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/GB_set_border_mode.md b/GB_set_border_mode.md index 176b861..cef9028 100644 --- a/GB_set_border_mode.md +++ b/GB_set_border_mode.md @@ -8,14 +8,24 @@ typedef enum { } GB_border_mode_t; ``` -void GB_set_border_mode([[GB_gameboy_t]] *gb, [[GB_border_mode_t]] border_mode); +void GB_set_border_mode([[GB_gameboy_t]] *gb, GB_border_mode_t border_mode); In `gb.h` ## Description -TBD +This function controls whether an emulator instance should display a border or not: + +* `GB_BORDER_SGB`: Only display a border while emulating a Super Game Boy (default) +* `GB_BORDER_NEVER`: Never display a border +* `GB_BORDER_ALWAYS`: Always display a border + +When using `GB_BORDER_ALWAYS` while emulating a non-Super Game Boy [[model|GB_model_t]], SameBoy use the Super Game Boy border as the border if [[GB_set_boot_rom_load_callback]] was used. Otherwise, or if a Super Game Boy border was not found, a default border for the current model will be used instead. ## Thread Safety `GB_set_border_mode` is thread-safe and can be called from any thread and context. + +## See Also + +* [[GB_get_screen_width and GB_get_screen_height]] \ No newline at end of file