summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorkobewi <kobewi4e@gmail.com>2022-02-25 01:19:24 +0100
committerkobewi <kobewi4e@gmail.com>2023-01-12 17:06:03 +0100
commitdfc4367a478f1d6c8f13aeb9d8e0be01156f5afb (patch)
tree42fc219bcf1d5d76b8cb5225e85bd7dc00a9b07b /doc/classes
parentcaf94f244e1a952300c6426f5d7d9939dd93d472 (diff)
Add expand modes to TextureRect
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/TextureRect.xml24
1 files changed, 21 insertions, 3 deletions
diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml
index 348b4a5837..460ffbbb80 100644
--- a/doc/classes/TextureRect.xml
+++ b/doc/classes/TextureRect.xml
@@ -10,15 +10,15 @@
<link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
</tutorials>
<members>
+ <member name="expand_mode" type="int" setter="set_expand_mode" getter="get_expand_mode" enum="TextureRect.ExpandMode" default="0">
+ Defines how minimum size is determined based on the texture's size. See [enum ExpandMode] for options.
+ </member>
<member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h" default="false">
If [code]true[/code], texture is flipped horizontally.
</member>
<member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v" default="false">
If [code]true[/code], texture is flipped vertically.
</member>
- <member name="ignore_texture_size" type="bool" setter="set_ignore_texture_size" getter="get_ignore_texture_size" default="false">
- If [code]true[/code], the size of the texture won't be considered for minimum size calculation, so the [TextureRect] can be shrunk down past the texture size. Useful for preventing [TextureRect]s from breaking GUI layout regardless of their texture size.
- </member>
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="1" />
<member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureRect.StretchMode" default="0">
Controls the texture's behavior when resizing the node's bounding rectangle. See [enum StretchMode].
@@ -28,6 +28,24 @@
</member>
</members>
<constants>
+ <constant name="EXPAND_KEEP_SIZE" value="0" enum="ExpandMode">
+ The minimum size will be equal to texture size, i.e. [TextureRect] can't be smaller than the texture.
+ </constant>
+ <constant name="EXPAND_IGNORE_SIZE" value="1" enum="ExpandMode">
+ The size of the texture won't be considered for minimum size calculation, so the [TextureRect] can be shrunk down past the texture size.
+ </constant>
+ <constant name="EXPAND_FIT_WIDTH" value="2" enum="ExpandMode">
+ The height of the texture will be ignored. Minimum width will be equal to the current height. Useful for horizontal layouts, e.g. inside [HBoxContainer].
+ </constant>
+ <constant name="EXPAND_FIT_WIDTH_PROPORTIONAL" value="3" enum="ExpandMode">
+ Same as [constant EXPAND_FIT_WIDTH], but keeps texture's aspect ratio.
+ </constant>
+ <constant name="EXPAND_FIT_HEIGHT" value="4" enum="ExpandMode">
+ The width of the texture will be ignored. Minimum height will be equal to the current width. Useful for vertical layouts, e.g. inside [VBoxContainer].
+ </constant>
+ <constant name="EXPAND_FIT_HEIGHT_PROPORTIONAL" value="5" enum="ExpandMode">
+ Same as [constant EXPAND_FIT_HEIGHT], but keeps texture's aspect ratio.
+ </constant>
<constant name="STRETCH_SCALE" value="0" enum="StretchMode">
Scale to fit the node's bounding rectangle.
</constant>