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

Documented input modes.

Browse Source
This commit is contained in:
Camilla Berglund 2013-03-12 19:39:36 +01:00
parent bb10cae0be
commit 39fe1f1ea6
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
include/GL/glfw3.h
View File

@ -1445,10 +1445,8 @@ GLFWAPI void glfwWaitEvents(void);
/*! @brief Returns the value of an input option for the specified window. /*! @brief Returns the value of an input option for the specified window.
* @param[in] window The window to query. * @param[in] window The window to query.
* @param[in] mode One of the following: * @param[in] mode One of `GLFW_CURSOR_MODE`, `GLFW_STICKY_KEYS` or
* * `GLFW_CURSOR_MODE` Sets the cursor mode. * `GLFW_STICKY_MOUSE_BUTTONS`.
* * `GLFW_STICKY_KEYS` Sets whether sticky keys are enabled.
* * `GLFW_STICKY_MOUSE_BUTTONS` Sets whether sticky mouse buttons are enabled.
* @ingroup input * @ingroup input
* *
* @sa glfwSetInputMode * @sa glfwSetInputMode
@ -1462,6 +1460,26 @@ GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);
* @param[in] value The new value of the specified input mode. * @param[in] value The new value of the specified input mode.
* @ingroup input * @ingroup input
* *
* If `mode` is `GLFW_CURSOR_MODE`, the value must be one of the supported input
* modes:
* * `GLFW_CURSOR_NORMAL` makes the cursor visible and behaving normally.
* * `GLFW_CURSOR_HIDDEN` makes the cursor invisible when it is over the client
* area of the window.
* * `GLFW_CURSOR_CAPTURED` makes the cursor invisible and unable to leave the
* window but unconstrained in terms of position.
*
* If `mode` is `GLFW_STICKY_KEYS`, the value must be either `GL_TRUE` to
* enable sticky keys, or `GL_FALSE` to disable it. If sticky keys are
* enabled, a key press will ensure that @ref glfwGetKey returns @ref
* GLFW_PRESS the next time it is called even if the key had been released
* before the call.
*
* If `mode` is `GLFW_STICKY_MOUSE_BUTTONS`, the value must be either `GL_TRUE`
* to enable sticky mouse buttons, or `GL_FALSE` to disable it. If sticky
* mouse buttons are enabled, a mouse button press will ensure that @ref
* glfwGetMouseButton returns @ref GLFW_PRESS the next time it is called even
* if the mouse button had been released before the call.
*
* @bug **Mac OS X:** The @ref GLFW_CURSOR_HIDDEN value of @ref * @bug **Mac OS X:** The @ref GLFW_CURSOR_HIDDEN value of @ref
* GLFW_CURSOR_MODE is not yet implemented. * GLFW_CURSOR_MODE is not yet implemented.
* *