Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2025-06-14 19:52:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc: Improve contents

Browse Source
This commit is contained in:
Daijiro Fukuda 2022-05-20 18:50:17 +09:00
parent 5ef1fe666b
commit 7383bf5f0f
1 changed files with 7 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/GLFW/glfw3.h
View File

@ -4562,8 +4562,8 @@ GLFWAPI void glfwPostEmptyEvent(void);
* *
* @param[in] window The window to query. * @param[in] window The window to query.
* @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS`, * @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS`,
* `GLFW_STICKY_MOUSE_BUTTONS`, `GLFW_LOCK_KEY_MODS` or * `GLFW_STICKY_MOUSE_BUTTONS`, `GLFW_LOCK_KEY_MODS`, `GLFW_RAW_MOUSE_MOTION`,
* `GLFW_RAW_MOUSE_MOTION`. * or `GLFW_IME`.
* *
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
* GLFW_INVALID_ENUM. * GLFW_INVALID_ENUM.
@ -5077,8 +5077,7 @@ GLFWAPI void glfwGetPreeditCursorPos(GLFWwindow* window, int *x, int *y, int *h)
* This function teach position hint to decide the candidate window. The candidate window * This function teach position hint to decide the candidate window. The candidate window
* is a part of IME(Input Method Editor) and show several candidate strings. * is a part of IME(Input Method Editor) and show several candidate strings.
* *
* Windows sytems decide proper pisition from text cursor geometry. * Windows systems decide proper position from text cursor geometry.
* You should call this function in preedit callback.
* *
* @param[in] window The window to set the text cursor for. * @param[in] window The window to set the text cursor for.
* @param[in] x The text cursor x position (relative position from window coordinates). * @param[in] x The text cursor x position (relative position from window coordinates).
@ -5250,8 +5249,8 @@ GLFWAPI GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow* window, GLFWcharmods
/*! @brief Sets the preedit callback. /*! @brief Sets the preedit callback.
* *
* This function sets the preedit callback of the specified * This function sets the preedit callback of the specified
* window, which is called when an IME is processing text before commited. * window, which is called when an IME is processing text before committed.
* *
* Callback receives relative position of input cursor inside preedit text and * Callback receives relative position of input cursor inside preedit text and
* attributed text blocks. This callback is used for on-the-spot text editing * attributed text blocks. This callback is used for on-the-spot text editing
@ -5276,12 +5275,8 @@ GLFWAPI GLFWpreeditfun glfwSetPreeditCallback(GLFWwindow* window, GLFWpreeditfun
/*! @brief Sets the IME status change callback. /*! @brief Sets the IME status change callback.
* *
* This function sets the preedit callback of the specified * This function sets the IME status callback of the specified
* window, which is called when an IME is processing text before commited. * window, which is called when an IME is switched on and off.
*
* Callback receives relative position of input cursor inside preedit text and
* attributed text blocks. This callback is used for on-the-spot text editing
* with IME.
* *
* @param[in] window The window whose callback to set. * @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set * @param[in] cbfun The new callback, or `NULL` to remove the currently set