document the purpose of SDL_SetTextInputRect

This commit is contained in:
shenleban tongying authored and Sam Lantinga committed 2023-11-28 12:06:16 -08:00
1 parent 1e12d7cfb6
commit 3e6513c773
1 file changed
+3 -1
+3 -1
View File
@@ -300,7 +300,9 @@ extern DECLSPEC void SDLCALL SDL_ClearComposition(void);
extern DECLSPEC SDL_bool SDLCALL SDL_TextInputShown(void); extern DECLSPEC SDL_bool SDLCALL SDL_TextInputShown(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 * To start text input in a given location, this function is intended to be
* called before SDL_StartTextInput, although some platforms support moving * called before SDL_StartTextInput, although some platforms support moving