Updated GB_set_border_mode (markdown)

Lior Halphon 2024-11-27 23:36:25 +02:00
parent 07eb4cc3a2
commit b1a02bfd93
1 changed files with 12 additions and 2 deletions

@ -8,14 +8,24 @@ typedef enum {
} GB_border_mode_t;
```
<tt>void GB_set_border_mode([[GB_gameboy_t]] *gb, [[GB_border_mode_t]] border_mode);</tt>
<tt>void GB_set_border_mode([[GB_gameboy_t]] *gb, GB_border_mode_t border_mode);</tt>
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]]