Browse Source

Merge pull request #58643 from KoBeWi/👀

Update some docs regarding SubViewports
Max Hilbrunner 3 years ago
parent
commit
cfd4433bbc
3 changed files with 4 additions and 4 deletions
  1. 1 0
      doc/classes/SubViewport.xml
  2. 2 2
      doc/classes/SubViewportContainer.xml
  3. 1 2
      doc/classes/Viewport.xml

+ 1 - 0
doc/classes/SubViewport.xml

@@ -4,6 +4,7 @@
 		Creates a sub-view into the screen.
 		Creates a sub-view into the screen.
 	</brief_description>
 	</brief_description>
 	<description>
 	<description>
+		[SubViewport] is a [Viewport] that isn't a [Window], i.e. it doesn't draw anything by itself. To display something, [SubViewport]'s [member size] must be non-zero and it should be either put inside a [SubViewportContainer] or assigned to a [ViewportTexture].
 	</description>
 	</description>
 	<tutorials>
 	<tutorials>
 		<link title="Using Viewports">$DOCS_URL/tutorials/rendering/viewports.html</link>
 		<link title="Using Viewports">$DOCS_URL/tutorials/rendering/viewports.html</link>

+ 2 - 2
doc/classes/SubViewportContainer.xml

@@ -4,7 +4,7 @@
 		Control for holding [SubViewport]s.
 		Control for holding [SubViewport]s.
 	</brief_description>
 	</brief_description>
 	<description>
 	<description>
-		A [Container] node that holds a [SubViewport], automatically setting its size.
+		A [Container] node that holds a [SubViewport]. It uses the [SubViewport]'s size as minimum size, unless [member stretch] is enabled.
 		[b]Note:[/b] Changing a SubViewportContainer'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 SubViewportContainer'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] The SubViewportContainer forwards mouse-enter and mouse-exit notifications to its sub-viewports.
 		[b]Note:[/b] The SubViewportContainer forwards mouse-enter and mouse-exit notifications to its sub-viewports.
 	</description>
 	</description>
@@ -12,7 +12,7 @@
 	</tutorials>
 	</tutorials>
 	<members>
 	<members>
 		<member name="stretch" type="bool" setter="set_stretch" getter="is_stretch_enabled" default="false">
 		<member name="stretch" type="bool" setter="set_stretch" getter="is_stretch_enabled" default="false">
-			If [code]true[/code], the sub-viewport will be scaled to the control's size.
+			If [code]true[/code], the sub-viewport will be automatically resized to the control's size.
 		</member>
 		</member>
 		<member name="stretch_shrink" type="int" setter="set_stretch_shrink" getter="get_stretch_shrink" default="1">
 		<member name="stretch_shrink" type="int" setter="set_stretch_shrink" getter="get_stretch_shrink" default="1">
 			Divides the sub-viewport's effective resolution by this value while preserving its scale. This can be used to speed up rendering.
 			Divides the sub-viewport's effective resolution by this value while preserving its scale. This can be used to speed up rendering.

+ 1 - 2
doc/classes/Viewport.xml

@@ -1,12 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="Viewport" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
 <class name="Viewport" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
 	<brief_description>
 	<brief_description>
-		Creates a sub-view into the screen.
+		Base class for viewports.
 	</brief_description>
 	</brief_description>
 	<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 Camera3D 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 Camera3D 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 [SubViewportContainer], it will automatically take up its 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.