From 2ae46fa90a192e31ef76aa4fa0bca31743c4e12f Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Wed, 4 Dec 2013 19:12:24 +0100 Subject: [PATCH] Added notes on window refresh. --- include/GLFW/glfw3.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 354878bf..e8f24f12 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -1691,6 +1691,12 @@ GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window * This function is no longer called by @ref glfwSwapBuffers. You need to call * it or @ref glfwWaitEvents yourself. * + * @remarks On some platforms, a window move, resize or menu operation will + * cause event processing to block. This is due to how event processing is + * designed on those platforms. You can use the + * [window refresh callback](@ref GLFWwindowrefreshfun) to redraw the contents + * of your window when necessary during the operation. + * * @note This function may only be called from the main thread. * * @note This function may not be called from a callback. @@ -1718,6 +1724,12 @@ GLFWAPI void glfwPollEvents(void); * * This function is not required for joystick input to work. * + * @remarks On some platforms, a window move, resize or menu operation will + * cause event processing to block. This is due to how event processing is + * designed on those platforms. You can use the + * [window refresh callback](@ref GLFWwindowrefreshfun) to redraw the contents + * of your window when necessary during the operation. + * * @note This function may only be called from the main thread. * * @note This function may not be called from a callback.