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

Added window attribute remarks.

Browse Source 
Fixes #485.
Related to #476.
This commit is contained in:
Camilla Berglund 2015-04-07 14:34:12 +02:00
parent d95b79f9eb
commit 59abeeb097
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/GLFW/glfw3.h
View File

@ -2035,6 +2035,14 @@ GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
* @return The value of the attribute, or zero if an
* [error](@ref error_handling) occurred.
*
* @remarks Framebuffer related hints are not window attributes. See @ref
* window_attribs_fb for more information.
*
* @remarks Zero is a valid value for many window and context related
* attributes so you cannot use a return value of zero as an indication of
* errors. However, this function should not fail as long as it is passed
* valid arguments and the library has been [initialized](@ref intro_init).
*
* @par Thread Safety
* This function may only be called from the main thread.
*