From 2867ca1e5b003b167fac33e8136a4698bb3aa074 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Camilla=20L=C3=B6wy?= Date: Sun, 29 Oct 2017 16:27:15 +0100 Subject: [PATCH] Documentation work Fixes #1104. --- docs/window.dox | 14 +++++++------- include/GLFW/glfw3.h | 5 +++-- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/window.dox b/docs/window.dox index 7961e028..f2146502 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -582,15 +582,15 @@ window's desired video mode. The video mode most closely matching the new desired video mode is set immediately. The window is resized to fit the resolution of the set video mode. -If you wish to be notified when a window is resized, whether by the user or -the system, set a size callback. +If you wish to be notified when a window is resized, whether by the user, the +system or your own code, set a size callback. @code glfwSetWindowSizeCallback(window, window_size_callback); @endcode The callback function receives the new size, in screen coordinates, of the -client area of the window when it is resized. +client area of the window when the window is resized. @code void window_size_callback(GLFWwindow* window, int width, int height) @@ -740,15 +740,15 @@ The window system may put limitations on window placement. glfwSetWindowPos(window, 100, 100); @endcode -If you wish to be notified when a window is moved, whether by the user, system -or your own code, set a position callback. +If you wish to be notified when a window is moved, whether by the user, the +system or your own code, set a position callback. @code glfwSetWindowPosCallback(window, window_pos_callback); @endcode -The callback function receives the new position of the upper-left corner of the -client area when the window is moved. +The callback function receives the new position, in screen coordinates, of the +upper-left corner of the client area when the window is moved. @code void window_pos_callback(GLFWwindow* window, int xpos, int ypos) diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 0ba409b0..6923ba68 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -3220,8 +3220,9 @@ GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window); /*! @brief Sets the position callback for the specified window. * * This function sets the position callback of the specified window, which is - * called when the window is moved. The callback is provided with the screen - * position of the upper-left corner of the client area of the window. + * called when the window is moved. The callback is provided with the + * position, in screen coordinates, of the upper-left corner of the client area + * of the window. * * @param[in] window The window whose callback to set. * @param[in] cbfun The new callback, or `NULL` to remove the currently set