Commit 21437ad3f87d2e521f3c81e5de31a01f1f2301d0

Sam Lantinga 2022-07-05T21:41:22

Merge commit 'fcb99d783090cc15bc04cdebe877ab36a3697e3d' into main

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/SDL_keyboard.h b/include/SDL_keyboard.h
index 0aa5990..b19a293 100644
--- a/include/SDL_keyboard.h
+++ b/include/SDL_keyboard.h
@@ -288,7 +288,11 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsTextInputShown(void);
 /**
  * Set the rectangle used to type Unicode text inputs.
  *
- * Note: If you want use system native IME window, try to set hint
+ * 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.
+ *
+ * Note: If you want to use the system native IME window, try setting hint
  * **SDL_HINT_IME_SHOW_UI** to **1**, otherwise this function won't give you
  * any feedback.
  *