mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-29 07:34:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work

Browse Source 
Related to #981.
This commit is contained in:
Camilla Löwy 2017-04-04 18:05:36 +02:00
parent c9003b5547
commit 9558b85f7b
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/GLFW/glfw3.h
View File

@ -3392,11 +3392,12 @@ GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);
*/ */
GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value); GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);
/*! @brief Returns the localized name of the specified printable key. /*! @brief Returns the layout-specific name of the specified printable key.
* *
* This function returns the name of the specified printable key. This is * This function returns the name of the specified printable key, encoded as
* typically the character that key would produce without any modifier keys, * UTF-8. This is typically the character that key would produce without any
* intended for displaying key bindings to the user. * modifier keys, intended for displaying key bindings to the user. For dead
* keys, it is typically the diacritic it would add to a character.
* *
* __Do not use this function__ for [text input](@ref input_char). You will * __Do not use this function__ for [text input](@ref input_char). You will
* break text input for many languages even if it happens to work for yours. * break text input for many languages even if it happens to work for yours.
@ -3438,7 +3439,7 @@ GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);
* *
* @param[in] key The key to query, or `GLFW_KEY_UNKNOWN`. * @param[in] key The key to query, or `GLFW_KEY_UNKNOWN`.
* @param[in] scancode The scancode of the key to query. * @param[in] scancode The scancode of the key to query.
* @return The localized name of the key, or `NULL`. * @return The UTF-8 encoded, layout-specific name of the key, or `NULL`.
* *
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
* GLFW_PLATFORM_ERROR. * GLFW_PLATFORM_ERROR.