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

Added notes on window refresh.

Browse Source
This commit is contained in:
Camilla Berglund 2013-12-04 19:12:24 +01:00
parent 0c0bb28d39
commit 2ae46fa90a
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/GLFW/glfw3.h
View File

@ -1691,6 +1691,12 @@ GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window
* This function is no longer called by @ref glfwSwapBuffers. You need to call * This function is no longer called by @ref glfwSwapBuffers. You need to call
* it or @ref glfwWaitEvents yourself. * 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 only be called from the main thread.
* *
* @note This function may not be called from a callback. * @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. * 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 only be called from the main thread.
* *
* @note This function may not be called from a callback. * @note This function may not be called from a callback.