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

Documented that out parameters always get set.

Browse Source
This commit is contained in:
Camilla Berglund 2013-05-15 15:01:42 +02:00
parent e20e8f9954
commit c00d057eda
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/GL/glfw3.h
View File

@ -934,7 +934,8 @@ GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun cbfun);
* This function returns an array of handles for all currently connected * This function returns an array of handles for all currently connected
* monitors. * monitors.
* *
* @param[out] count The size of the returned array. * @param[out] count The size of the returned array, or zero if an error
* occurred.
* @return An array of monitor handles, or `NULL` if an error occurred. * @return An array of monitor handles, or `NULL` if an error occurred.
* *
* @note The returned array is valid only until the monitor configuration * @note The returned array is valid only until the monitor configuration
@ -1027,7 +1028,8 @@ GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun cbfun);
* product of width and height). * product of width and height).
* *
* @param[in] monitor The monitor to query. * @param[in] monitor The monitor to query.
* @param[out] count The number of video modes in the returned array. * @param[out] count The number of video modes in the returned array, or zero
* if an error occurred.
* @return An array of video modes, or `NULL` if an error occurred. * @return An array of video modes, or `NULL` if an error occurred.
* *
* @note The returned array is valid only until this function is called again * @note The returned array is valid only until this function is called again