Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-25 11:35:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work

Browse Source 
Fixes #920.
Related to #1322.
This commit is contained in:
Camilla Löwy 2019-02-25 14:46:48 +01:00
parent 3a2a97f15d
commit a43d1a4937
4 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -141,7 +141,8 @@ information on what to include when reporting a bug.
(#235,#439,#677,#845,#898) (#235,#439,#677,#845,#898)
- Added `glfwRequestWindowAttention` function for requesting attention from the - Added `glfwRequestWindowAttention` function for requesting attention from the
user (#732,#988) user (#732,#988)
- Added `glfwGetMonitorWorkarea` function for querying the monitor work area - Added `glfwGetMonitorWorkarea` function for retrieving the monitor work area
(#920,#989,#1322)
- Added `glfwGetKeyScancode` function that allows retrieving platform dependent - Added `glfwGetKeyScancode` function that allows retrieving platform dependent
scancodes for keys (#830) scancodes for keys (#830)
- Added `glfwSetWindowMaximizeCallback` and `GLFWwindowmaximizefun` for - Added `glfwSetWindowMaximizeCallback` and `GLFWwindowmaximizefun` for

12
docs/monitor.dox
View File

@ -174,6 +174,18 @@ glfwGetMonitorPos(monitor, &xpos, &ypos);
@endcode @endcode
@subsection monitor_workarea Work area
The area of a monitor not occupied by global task bars or menu bars is the work
area. This is specified in [screen coordinates](@ref coordinate_systems) and
can be retrieved with @ref glfwGetMonitorWorkarea.
@code
int xpos, ypos, width, height;
glfwGetMonitorWorkarea(monitor, &xpos, &ypos, &width, &height);
@endcode
@subsection monitor_name Human-readable name @subsection monitor_name Human-readable name
The human-readable, UTF-8 encoded name of a monitor is returned by @ref The human-readable, UTF-8 encoded name of a monitor is returned by @ref

8
docs/news.dox
View File

@ -80,6 +80,14 @@ Windows and X11 where this is necessary.
@see @ref window_scale @see @ref window_scale
@subsection news_33_workarea Support for monitor work area
GLFW now supports querying the work area of a monitor, i.e. the area not
occupied by task bars or global menu bars, with @ref glfwGetMonitorWorkarea.
@see @ref monitor_workarea
@subsection news_33_inithint Support for initialization hints @subsection news_33_inithint Support for initialization hints
GLFW now supports setting library initialization hints with @ref glfwInitHint. GLFW now supports setting library initialization hints with @ref glfwInitHint.

4
include/GLFW/glfw3.h
View File

@ -1931,7 +1931,7 @@ GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void);
*/ */
GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos); GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
/*! @brief Returns the work area of the monitor. /*! @brief Retrives 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 work area of the specified monitor along with the work area * corner of the work area of the specified monitor along with the work area
@ -1954,7 +1954,7 @@ GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
* *
* @thread_safety This function must only be called from the main thread. * @thread_safety This function must only be called from the main thread.
* *
* @sa @ref monitor_properties * @sa @ref monitor_workarea
* *
* @since Added in version 3.3. * @since Added in version 3.3.
* *