From 59abeeb097d3423825fd25872c3cdad5b85e82a9 Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Tue, 7 Apr 2015 14:34:12 +0200 Subject: [PATCH] Added window attribute remarks. Fixes #485. Related to #476. --- include/GLFW/glfw3.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 818a4b12..ece53898 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -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. *