From ede9acbde487af6677cd13e755e2bd5bed97f1b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 17 Jan 2015 14:22:19 +0100 Subject: [PATCH] Document default values on viewport and scissor rectangles. --- src/Magnum/AbstractFramebuffer.h | 4 +++- src/Magnum/DefaultFramebuffer.h | 3 +-- src/Magnum/Renderer.h | 1 + 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/Magnum/AbstractFramebuffer.h b/src/Magnum/AbstractFramebuffer.h index 55ce6aa0b..76c2f8e49 100644 --- a/src/Magnum/AbstractFramebuffer.h +++ b/src/Magnum/AbstractFramebuffer.h @@ -276,7 +276,9 @@ class MAGNUM_EXPORT AbstractFramebuffer { * * Saves the viewport to be used at later time in @ref bind(). If the * framebuffer is currently bound, updates the viewport to given - * rectangle. + * rectangle. Initial value in @ref DefaultFramebuffer is set to cover + * whole window, in @ref Framebuffer the initial value is specified in + * constructor. * @see @ref maxViewportSize(), @fn_gl{Viewport} */ AbstractFramebuffer& setViewport(const Range2Di& rectangle); diff --git a/src/Magnum/DefaultFramebuffer.h b/src/Magnum/DefaultFramebuffer.h index 6c4ab0a72..122244c4a 100644 --- a/src/Magnum/DefaultFramebuffer.h +++ b/src/Magnum/DefaultFramebuffer.h @@ -38,8 +38,7 @@ namespace Magnum { Default framebuffer, i.e. the actual screen surface. It is automatically created when @ref Context is created and it is available through global -variable @ref defaultFramebuffer. It is by default mapped to whole screen -surface. +variable @ref defaultFramebuffer. @anchor DefaultFramebuffer-usage ## Usage diff --git a/src/Magnum/Renderer.h b/src/Magnum/Renderer.h index ab1cb55df..cc8513e9f 100644 --- a/src/Magnum/Renderer.h +++ b/src/Magnum/Renderer.h @@ -483,6 +483,7 @@ class MAGNUM_EXPORT Renderer { /** * @brief Set scissor rectangle * + * Initial value is set to cover whole window. * @see @ref Feature::ScissorTest, @fn_gl{Scissor} */ static void setScissor(const Range2Di& rectangle);