Fix ImGuiKey mapping for SDL2 and SDL3 by translation method

[eszdman]

As mentioned in #7670, SDL2 partially reports SDL_Keycode as symbols depending on the keyboard layout in SDL initialization. Since ImGui's target is to use translated symbols in en-US layout, I implemented ImGui_ImplSDL_TranslateUntranslatedKey

[ocornut]

It seems like a bug in SDL that you would get e.g. a keycode of 1081 since this doesn't correspond to a SDL_Keycode value in the enumeration. I think you should bring it to SDL to try to get an explanation about it first.

I see that you converted the logic from GLFW, however:

• GLFW has an exception for KEYPAD keys (GLFW_KEY_KP_0 to GLFW_KEY_KP_EQUAL) while your conversion does something differently and technically faulty.
• The result won't be translated keys at all, since it is using scancode names.

There's probably an interesting fallback to use based on scancode, and maybe this is it, but you first need to check with SDL why you are getting those values on your system/setup.

[eszdman]

It seems like a bug in SDL that you would get e.g. a keycode of 1081 since this doesn't correspond to a SDL_Keycode value in the enumeration. I think you should bring it to SDL to try to get an explanation about it first.

I issued SDL with this, it's clearly expected behaviour of SDL_Keycode and enumeration declared only as example on an en-US keyboard libsdl-org/SDL#10002 (comment)

[ocornut]

Since ImGui's target is to use translated symbols in en-US layout,

It's not. We aim to use translated characters in the current layout.
As such the proposed PR is invalid, as it mostly rely on SDL_GetScancodeName().
I however acknowledge your issue with ru layout and will investigate a solution.

[ocornut]

@eszdman I don't have enough information to solve this reliably.

Could you update SDL3 and add those exact prints in imgui_impl_sdl3.cpp's SDL_EVENT_KEY_DOWN handler.

IMGUI_DEBUG_LOG("SDL_EVENT_KEY_%s : key=%d ('%s'), scancode=%d ('%s'), mod=%X\n",
    (event->type == SDL_EVENT_KEY_DOWN) ? "DOWN" : "UP", event->key.key, SDL_GetKeyName(event->key.key), event->key.scancode, SDL_GetScancodeName(event->key.scancode), event->key.mod);

And for SDL2:

IMGUI_DEBUG_LOG("SDL_KEY_%s : key=%d ('%s'), scancode=%d ('%s'), mod=%X\n",
   (event->type == SDL_KEYDOWN) ? "DOWN" : "UP  ", event->key.keysym.sym, SDL_GetKeyName(event->key.keysym.sym), event->key.keysym.scancode, SDL_GetScancodeName(event->key.keysym.scancode), event->key.keysym.mod);

Then goes through the first row (qwertyuiop) ?
Make sure things are printed after the ImGui_ImplSDL3_UpdateKeyModifiers() call (but you may double check that before/after doesn't make a difference on your setup)
Thank you!

[ocornut]

Hello @eszdman,

I would like to move forward with that. I found out that the functions mentioned in libsdl-org/SDL#10002 (comment) were all removed.

I could work on the solution based on scancodes, but cannot seem to reproduce the issue locally.
I added a Russian keyboard on my Windows 10, and I get regular keys, not the ones you are listing in #7670 (comment)

Do you still get this issue with SDL2 and or SDL3 ?
Do you know what parameter I should change to get the issue on my side?