mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-12 17:51:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work.

Browse Source 
This adds documentation for work area size.

Related to #1322.
This commit is contained in:
Doug Binks 2018-09-08 17:24:57 +02:00 committed by Camilla Löwy
parent 6907629cbf
commit f1d40fa046
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/GLFW/glfw3.h
View File

@ -1934,7 +1934,10 @@ GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
/*! @brief Returns the work area of the monitor. /*! @brief Returns the work area of the monitor.
* *
* This function returns the position, in screen coordinates, of the upper-left * 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 * 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. * non-`NULL` position and size arguments will be set to zero.