From bfe2d42af4bf26880b165496fba3c4f5be8b064b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Camilla=20L=C3=B6wy?= Date: Mon, 27 Nov 2017 01:18:51 +0100 Subject: [PATCH] Documentation work --- docs/context.dox | 3 +-- docs/window.dox | 6 ++++++ include/GLFW/glfw3.h | 11 +++++------ 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/context.dox b/docs/context.dox index 58c62217..e94448dc 100644 --- a/docs/context.dox +++ b/docs/context.dox @@ -129,8 +129,7 @@ error. @section context_swap Buffer swapping -Buffer swapping is part of the window and framebuffer, not the context. See -@ref buffer_swap. +See @ref buffer_swap in the window guide. @section context_glext OpenGL and OpenGL ES extensions diff --git a/docs/window.dox b/docs/window.dox index 2c9cec91..db29d611 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -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 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. + */ diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index dfff8d3d..9c02401d 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -4969,12 +4969,11 @@ GLFWAPI void glfwSwapBuffers(GLFWwindow* window); * is sometimes called _vertical synchronization_, _vertical retrace * synchronization_ or just _vsync_. * - * Contexts that support either of the `WGL_EXT_swap_control_tear` and - * `GLX_EXT_swap_control_tear` extensions also accept negative swap intervals, - * which allow the driver to swap even if a frame arrives a little bit late. - * You can check for the presence of these extensions using @ref - * glfwExtensionSupported. For more information about swap tearing, see the - * extension specifications. + * A context that support either of the `WGL_EXT_swap_control_tear` and + * `GLX_EXT_swap_control_tear` extensions also accepts _negative_ swap + * intervals, which allows the driver to swap immediately even if a frame + * arrives a little bit late. You can check for these extensions with @ref + * glfwExtensionSupported. * * 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.