mirror of
https://github.com/glfw/glfw.git
synced 2024-11-10 00:51:47 +00:00
Documentation work.
This adds documentation for work area size. Related to #1322.
This commit is contained in:
parent
6907629cbf
commit
f1d40fa046
@ -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.
|
||||
|
Loading…
Reference in New Issue
Block a user