Skip to content

Commit

Permalink
Merge pull request #73251 from aaronfranke/3.x-viewport-doc
Browse files Browse the repository at this point in the history
[3.x] Improve the clarity of Viewport's documentation
  • Loading branch information
aaronfranke authored Feb 15, 2023
2 parents 8104416 + 1949b7c commit 50b45d6
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/classes/Viewport.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<description>
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.
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/ViewportContainer.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Control for holding [Viewport]s.
</brief_description>
<description>
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).
</description>
<tutorials>
Expand Down

0 comments on commit 50b45d6

Please sign in to comment.