mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-06-22 07:20:00 +00:00
parent 90034b16dc
commit ba188e7555
1 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
include/SDL3/SDL_hints.h
View File

@ -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.
*