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

Clarify monitor reference documentation

Browse Source 
Related to #594.
This commit is contained in:
Camilla Berglund 2015-09-17 16:37:09 +02:00
parent cf9079c783
commit f5cbdbab4f
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/GLFW/glfw3.h
View File

@ -1212,12 +1212,13 @@ GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun cbfun);
/*! @brief Returns the currently connected monitors. /*! @brief Returns the currently connected monitors.
* *
* This function returns an array of handles for all currently connected * This function returns an array of handles for all currently connected
* monitors. * monitors. The primary monitor is always first in the returned array. If no
* monitors were found, this function returns `NULL`.
* *
* @param[out] count Where to store the number of monitors in the returned * @param[out] count Where to store the number of monitors in the returned
* array. This is set to zero if an error occurred. * array. This is set to zero if an error occurred.
* @return An array of monitor handles, or `NULL` if an * @return An array of monitor handles, or `NULL` if no monitors were found or
* [error](@ref error_handling) occurred. * if an [error](@ref error_handling) occurred.
* *
* @par Pointer Lifetime * @par Pointer Lifetime
* The returned array is allocated and freed by GLFW. You should not free it * The returned array is allocated and freed by GLFW. You should not free it
@ -1240,14 +1241,17 @@ GLFWAPI GLFWmonitor** glfwGetMonitors(int* count);
/*! @brief Returns the primary monitor. /*! @brief Returns the primary monitor.
* *
* This function returns the primary monitor. This is usually the monitor * This function returns the primary monitor. This is usually the monitor
* where elements like the Windows task bar or the OS X menu bar are located. * where elements like the task bar or global menu bar are located.
* *
* @return The primary monitor, or `NULL` if an [error](@ref error_handling) * @return The primary monitor, or `NULL` if no monitors were found or if an
* occurred. * [error](@ref error_handling) occurred.
* *
* @par Thread Safety * @par Thread Safety
* This function may only be called from the main thread. * This function may only be called from the main thread.
* *
* @remarks The primary monitor is always first in the array returned by @ref
* glfwGetMonitors.
*
* @sa @ref monitor_monitors * @sa @ref monitor_monitors
* @sa glfwGetMonitors * @sa glfwGetMonitors
* *