diff options
Diffstat (limited to 'doc/classes/SubViewportContainer.xml')
| -rw-r--r-- | doc/classes/SubViewportContainer.xml | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/doc/classes/SubViewportContainer.xml b/doc/classes/SubViewportContainer.xml index 16d483e7f8..77aa7e3ff4 100644 --- a/doc/classes/SubViewportContainer.xml +++ b/doc/classes/SubViewportContainer.xml @@ -1,19 +1,18 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SubViewportContainer" inherits="Container" version="4.0"> +<class name="SubViewportContainer" inherits="Container" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Control for holding [SubViewport]s. </brief_description> <description> - A [Container] node that holds a [SubViewport], automatically setting its size. - [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). + 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.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. </description> <tutorials> </tutorials> - <methods> - </methods> <members> <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 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. @@ -21,6 +20,4 @@ [b]Note:[/b] [member stretch] must be [code]true[/code] for this property to work. </member> </members> - <constants> - </constants> </class> |