document the purpose of SDL_SetTextInputRect

(cherry picked from commit 3e6513c77390969cd870726690bf89e39fe91e60)
This commit is contained in:
shenleban tongying 2023-11-28 15:00:04 -05:00 committed by Sam Lantinga
parent 546bab0a8c
commit be0e303ec8

View file

@ -298,7 +298,9 @@ 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