Fix cursor coordinate phrasing

Fixes #387.
This commit is contained in:
Camilla Berglund 2016-02-17 14:52:01 +01:00
parent 41b82903a8
commit 95c44ab298
2 changed files with 7 additions and 4 deletions

View File

@ -224,8 +224,9 @@ position callback.
glfwSetCursorPosCallback(window, cursor_pos_callback); glfwSetCursorPosCallback(window, cursor_pos_callback);
@endcode @endcode
The callback functions receives the cursor position. On platforms that provide The callback functions receives the cursor position, measured in screen
it, the full sub-pixel cursor position is passed on. coordinates but relative to the top-left corner of the window client area. On
platforms that provide it, the full sub-pixel cursor position is passed on.
@code @code
static void cursor_position_callback(GLFWwindow* window, double xpos, double ypos) static void cursor_position_callback(GLFWwindow* window, double xpos, double ypos)

View File

@ -956,8 +956,10 @@ typedef void (* GLFWmousebuttonfun)(GLFWwindow*,int,int,int);
* This is the function signature for cursor position callback functions. * This is the function signature for cursor position callback functions.
* *
* @param[in] window The window that received the event. * @param[in] window The window that received the event.
* @param[in] xpos The new x-coordinate, in screen coordinates, of the cursor. * @param[in] xpos The new cursor x-coordinate, relative to the left edge of
* @param[in] ypos The new y-coordinate, in screen coordinates, of the cursor. * the client area.
* @param[in] ypos The new cursor y-coordinate, relative to the top edge of the
* client area.
* *
* @sa @ref cursor_pos * @sa @ref cursor_pos
* @sa glfwSetCursorPosCallback * @sa glfwSetCursorPosCallback