From f1d40fa0469bc659468e5e37251e6c43d4e4068f Mon Sep 17 00:00:00 2001 From: Doug Binks Date: Sat, 8 Sep 2018 17:24:57 +0200 Subject: [PATCH] Documentation work. This adds documentation for work area size. Related to #1322. --- include/GLFW/glfw3.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 2abad171..01109a99 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -1934,7 +1934,10 @@ GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos); /*! @brief Returns the work area of the monitor. * * This function returns the position, in screen coordinates, of the upper-left - * corner of the specified monitor. + * corner of the work area of the specified monitor along with the + * work area size in screen coordinates. The work area is defined as the area of the + * monitor not occluded by the operating system task bar where present. If no task + * bar exists then the work area is the monitor resolution in screen coordinates. * * Any or all of the position and size arguments may be `NULL`. If an error occurs, all * non-`NULL` position and size arguments will be set to zero.