From 2fd12b2e8a3c37e99c13aaa44ae0870c2a2c3de9 Mon Sep 17 00:00:00 2001 From: Frank Praznik Date: Mon, 7 Oct 2024 19:21:34 -0400 Subject: [PATCH] keyboard: Note that enabling text input can also enable an IME An active IME can potentially eat key events, particularly dead keys and parts of a compose sequence, so note this behavior in the documentation. --- include/SDL3/SDL_keyboard.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/SDL3/SDL_keyboard.h b/include/SDL3/SDL_keyboard.h index f6ab13bb5..35a340c1a 100644 --- a/include/SDL3/SDL_keyboard.h +++ b/include/SDL3/SDL_keyboard.h @@ -322,7 +322,8 @@ extern SDL_DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromName(const char *name); * * Text input events are not received by default. * - * On some platforms using this function shows the screen keyboard. + * On some platforms using this function shows the screen keyboard and/or activates + * an IME, which can prevent some key press events from being passed through. * * \param window the window to enable text input. * \returns true on success or false on failure; call SDL_GetError() for more @@ -391,7 +392,8 @@ typedef enum SDL_Capitalization * * Text input events are not received by default. * - * On some platforms using this function shows the screen keyboard. + * On some platforms using this function shows the screen keyboard and/or activates + * an IME, which can prevent some key press events from being passed through. * * These are the supported properties: *