From be0e303ec819236eff4823536251e16dc32ba3af Mon Sep 17 00:00:00 2001 From: shenleban tongying Date: Tue, 28 Nov 2023 15:00:04 -0500 Subject: [PATCH] document the purpose of SDL_SetTextInputRect (cherry picked from commit 3e6513c77390969cd870726690bf89e39fe91e60) --- include/SDL_keyboard.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/SDL_keyboard.h b/include/SDL_keyboard.h index 86a37ad1a..413464ae2 100644 --- a/include/SDL_keyboard.h +++ b/include/SDL_keyboard.h @@ -298,8 +298,10 @@ extern DECLSPEC void SDLCALL SDL_ClearComposition(void); extern DECLSPEC SDL_bool SDLCALL SDL_IsTextInputShown(void); /** - * Set the rectangle used to type Unicode text inputs. - * + * Set the rectangle used to type Unicode text inputs. Native input methods + * will place a window with word suggestions near it, without covering the + * text being inputted. + * * To start text input in a given location, this function is intended to be * called before SDL_StartTextInput, although some platforms support moving * the rectangle even while text input (and a composition) is active.