asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[3.x] Improve the clarity of Viewport's documentation

Browse source
This commit is contained in:
Aaron Franke 2023-02-13 16:20:35 -06:00
parent 8104416337
commit 1949b7c652
No known key found for this signature in database
GPG key ID: 40A1750B977E56BF
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/Viewport.xml
View file

@ -6,7 +6,7 @@
<description> <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. 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. 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. 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. 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. Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw.

2
doc/classes/ViewportContainer.xml
View file

@ -4,7 +4,7 @@
Control for holding [Viewport]s. Control for holding [Viewport]s.
</brief_description> </brief_description>
<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). [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> </description>
<tutorials> <tutorials>