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

Documentation work

Browse Source
This commit is contained in:
Camilla Löwy 2017-11-27 01:18:51 +01:00
parent 1a250234ea
commit bfe2d42af4
3 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/context.dox
View File

@ -129,8 +129,7 @@ error.
@section context_swap Buffer swapping @section context_swap Buffer swapping
Buffer swapping is part of the window and framebuffer, not the context. See See @ref buffer_swap in the window guide.
@ref buffer_swap.
@section context_glext OpenGL and OpenGL ES extensions @section context_glext OpenGL and OpenGL ES extensions

6
docs/window.dox
View File

@ -1334,4 +1334,10 @@ Note that this may not work on all machines, as some drivers have
user-controlled settings that override any swap interval the application user-controlled settings that override any swap interval the application
requests. requests.
A context that supports either the `WGL_EXT_swap_control_tear` or the
`GLX_EXT_swap_control_tear` extension also accepts _negative_ swap intervals,
which allows the driver to swap immediately even if a frame arrives a little bit
late. This trades the risk of visible tears for greater framerate stability.
You can check for these extensions with @ref glfwExtensionSupported.
*/ */

11
include/GLFW/glfw3.h
View File

@ -4969,12 +4969,11 @@ GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
* is sometimes called _vertical synchronization_, _vertical retrace * is sometimes called _vertical synchronization_, _vertical retrace
* synchronization_ or just _vsync_. * synchronization_ or just _vsync_.
* *
* Contexts that support either of the `WGL_EXT_swap_control_tear` and * A context that support either of the `WGL_EXT_swap_control_tear` and
* `GLX_EXT_swap_control_tear` extensions also accept negative swap intervals, * `GLX_EXT_swap_control_tear` extensions also accepts _negative_ swap
* which allow the driver to swap even if a frame arrives a little bit late. * intervals, which allows the driver to swap immediately even if a frame
* You can check for the presence of these extensions using @ref * arrives a little bit late. You can check for these extensions with @ref
* glfwExtensionSupported. For more information about swap tearing, see the * glfwExtensionSupported.
* extension specifications.
* *
* A context must be current on the calling thread. Calling this function * A context must be current on the calling thread. Calling this function
* without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error. * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.