diff --git a/include/SDL3/SDL_hints.h b/include/SDL3/SDL_hints.h index 28895af38c..79fa091514 100644 --- a/include/SDL3/SDL_hints.h +++ b/include/SDL3/SDL_hints.h @@ -2006,18 +2006,30 @@ extern "C" { /** * A variable that controls keycode representation in keyboard events. * - * This variable is a comma separated set of options for translating keycodes in events: + * This variable is a comma separated set of options for translating keycodes + * in events: * - * - "unmodified": The keycode is the symbol generated by pressing the key without any modifiers applied. e.g. Shift+A would yield the keycode SDLK_a, or 'a'. - * - "modified": The keycode is the symbol generated by pressing the key with modifiers applied. e.g. Shift+A would yield the keycode SDLK_A, or 'A'. - * - "french_numbers": The number row on French keyboards is inverted, so pressing the 1 key would yield the keycode SDLK_1, or '1', instead of SDLK_AMPERSAND, or '&' - * - "latin_letters": For keyboards using non-Latin letters, such as Russian or Thai, the letter keys generate keycodes as though it had an en_US layout. e.g. pressing the key associated with SDL_SCANCODE_A on a Russian keyboard would yield 'a' instead of 'ф'. + * - "unmodified": The keycode is the symbol generated by pressing the key + * without any modifiers applied. e.g. Shift+A would yield the keycode + * SDLK_a, or 'a'. + * - "modified": The keycode is the symbol generated by pressing the key with + * modifiers applied. e.g. Shift+A would yield the keycode SDLK_A, or 'A'. + * - "french_numbers": The number row on French keyboards is inverted, so + * pressing the 1 key would yield the keycode SDLK_1, or '1', instead of + * SDLK_AMPERSAND, or '&' + * - "latin_letters": For keyboards using non-Latin letters, such as Russian + * or Thai, the letter keys generate keycodes as though it had an en_US + * layout. e.g. pressing the key associated with SDL_SCANCODE_A on a Russian + * keyboard would yield 'a' instead of 'ф'. * * The default value for this hint is equivalent to "modified,french_numbers" * - * Some platforms like Emscripten only provide modified keycodes and the options are not used. + * Some platforms like Emscripten only provide modified keycodes and the + * options are not used. * - * These options do not affect the return value of SDL_GetKeyFromScancode() or SDL_GetScancodeFromKey(), they just apply to the keycode included in key events. + * These options do not affect the return value of SDL_GetKeyFromScancode() or + * SDL_GetScancodeFromKey(), they just apply to the keycode included in key + * events. * * This hint can be set anytime. *