diff options
| author | Markus Sauermann <6299227+Sauermann@users.noreply.github.com> | 2022-10-04 21:53:18 +0200 |
|---|---|---|
| committer | Markus Sauermann <6299227+Sauermann@users.noreply.github.com> | 2023-01-31 22:53:43 +0100 |
| commit | decbda68d7067d597698908f53fceebc3247dfcd (patch) | |
| tree | c0baf53f9b90803aed252822b454369c98f25b3b /doc | |
| parent | 0056acf46fc88757cae9d9f6fe9805f0eec1cd09 (diff) | |
Prohibit inconsistent size state for SubViewport
Prohibit size changes of SubViewports with parent SubViewportContainers that have stretch mode enabled.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/SubViewport.xml | 1 | ||||
| -rw-r--r-- | doc/classes/SubViewportContainer.xml | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/SubViewport.xml b/doc/classes/SubViewport.xml index 7020cae1de..bb76a82ef3 100644 --- a/doc/classes/SubViewport.xml +++ b/doc/classes/SubViewport.xml @@ -26,6 +26,7 @@ </member> <member name="size" type="Vector2i" setter="set_size" getter="get_size" default="Vector2i(512, 512)"> The width and height of the sub-viewport. Must be set to a value greater than or equal to 2 pixels on both dimensions. Otherwise, nothing will be displayed. + [b]Note:[/b] If the parent node is a [SubViewportContainer] and its [member SubViewportContainer.stretch] is [code]true[/code], the viewport size cannot be changed manually. </member> <member name="size_2d_override" type="Vector2i" setter="set_size_2d_override" getter="get_size_2d_override" default="Vector2i(0, 0)"> The 2D size override of the sub-viewport. If either the width or height is [code]0[/code], the override is disabled. diff --git a/doc/classes/SubViewportContainer.xml b/doc/classes/SubViewportContainer.xml index 77aa7e3ff4..11137222a9 100644 --- a/doc/classes/SubViewportContainer.xml +++ b/doc/classes/SubViewportContainer.xml @@ -13,6 +13,7 @@ <members> <member name="stretch" type="bool" setter="set_stretch" getter="is_stretch_enabled" default="false"> If [code]true[/code], the sub-viewport will be automatically resized to the control's size. + [b]Note:[/b] If [code]true[/code], this will prohibit changing [member SubViewport.size] of its children manually. </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. |