From 1949b7c652256e2ace2fa17555f81b7b013faa60 Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Mon, 13 Feb 2023 16:20:35 -0600 Subject: [PATCH] [3.x] Improve the clarity of Viewport's documentation --- doc/classes/Viewport.xml | 2 +- doc/classes/ViewportContainer.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 6e3ad2039b7..1adde175aa4 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -6,7 +6,7 @@ A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will render on it too. Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports. - If a viewport is a child of a [ViewportContainer], it will automatically take up its size, otherwise it must be set manually. + If a viewport is a child of a [ViewportContainer], the viewport will automatically take up the container's size, otherwise it must be set manually. Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it. Also, viewports can be assigned to different screens in case the devices have multiple screens. Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw. diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml index 5334bb9275c..8d47f273fa2 100644 --- a/doc/classes/ViewportContainer.xml +++ b/doc/classes/ViewportContainer.xml @@ -4,7 +4,7 @@ Control for holding [Viewport]s. - A [Container] node that holds a [Viewport], automatically setting its size. + A [Container] node that holds a [Viewport], automatically setting the viewport's size. [b]Note:[/b] Changing a ViewportContainer's [member Control.rect_scale] will cause its contents to appear distorted. To change its visual size without causing distortion, adjust the node's margins instead (if it's not already in a container).