github_url:	hide

StyleBoxTexture

Inherits: :ref:`StyleBox<class_StyleBox>` < :ref:`Resource<class_Resource>` < :ref:`Reference<class_Reference>` < :ref:`Object<class_Object>`

Texture-based nine-patch :ref:`StyleBox<class_StyleBox>`.

Description

Texture-based nine-patch :ref:`StyleBox<class_StyleBox>`, in a way similar to :ref:`NinePatchRect<class_NinePatchRect>`. This stylebox performs a 3×3 scaling of a texture, where only the center cell is fully stretched. This makes it possible to design bordered styles regardless of the stylebox's size.

Properties

:ref:`AxisStretchMode<enum_StyleBoxTexture_AxisStretchMode>`	:ref:`axis_stretch_horizontal<class_StyleBoxTexture_property_axis_stretch_horizontal>`	0
:ref:`AxisStretchMode<enum_StyleBoxTexture_AxisStretchMode>`	:ref:`axis_stretch_vertical<class_StyleBoxTexture_property_axis_stretch_vertical>`	0
:ref:`bool<class_bool>`	:ref:`draw_center<class_StyleBoxTexture_property_draw_center>`	true
:ref:`float<class_float>`	:ref:`expand_margin_bottom<class_StyleBoxTexture_property_expand_margin_bottom>`	0.0
:ref:`float<class_float>`	:ref:`expand_margin_left<class_StyleBoxTexture_property_expand_margin_left>`	0.0
:ref:`float<class_float>`	:ref:`expand_margin_right<class_StyleBoxTexture_property_expand_margin_right>`	0.0
:ref:`float<class_float>`	:ref:`expand_margin_top<class_StyleBoxTexture_property_expand_margin_top>`	0.0
:ref:`float<class_float>`	:ref:`margin_bottom<class_StyleBoxTexture_property_margin_bottom>`	0.0
:ref:`float<class_float>`	:ref:`margin_left<class_StyleBoxTexture_property_margin_left>`	0.0
:ref:`float<class_float>`	:ref:`margin_right<class_StyleBoxTexture_property_margin_right>`	0.0
:ref:`float<class_float>`	:ref:`margin_top<class_StyleBoxTexture_property_margin_top>`	0.0
:ref:`Color<class_Color>`	:ref:`modulate_color<class_StyleBoxTexture_property_modulate_color>`	Color( 1, 1, 1, 1 )
:ref:`Texture2D<class_Texture2D>`	:ref:`normal_map<class_StyleBoxTexture_property_normal_map>`
:ref:`Rect2<class_Rect2>`	:ref:`region_rect<class_StyleBoxTexture_property_region_rect>`	Rect2( 0, 0, 0, 0 )
:ref:`Texture2D<class_Texture2D>`	:ref:`texture<class_StyleBoxTexture_property_texture>`

Methods

:ref:`float<class_float>`	:ref:`get_expand_margin_size<class_StyleBoxTexture_method_get_expand_margin_size>` ( :ref:`Margin<enum_@GlobalScope_Margin>` margin ) const
:ref:`float<class_float>`	:ref:`get_margin_size<class_StyleBoxTexture_method_get_margin_size>` ( :ref:`Margin<enum_@GlobalScope_Margin>` margin ) const
void	:ref:`set_expand_margin_all<class_StyleBoxTexture_method_set_expand_margin_all>` ( :ref:`float<class_float>` size )
void	:ref:`set_expand_margin_individual<class_StyleBoxTexture_method_set_expand_margin_individual>` ( :ref:`float<class_float>` size_left, :ref:`float<class_float>` size_top, :ref:`float<class_float>` size_right, :ref:`float<class_float>` size_bottom )
void	:ref:`set_expand_margin_size<class_StyleBoxTexture_method_set_expand_margin_size>` ( :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` size )
void	:ref:`set_margin_size<class_StyleBoxTexture_method_set_margin_size>` ( :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` size )

Signals

• texture_changed ( )

Emitted when the stylebox's texture is changed.

Enumerations

enum AxisStretchMode:

• AXIS_STRETCH_MODE_STRETCH = 0 --- Stretch the stylebox's texture. This results in visible distortion unless the texture size matches the stylebox's size perfectly.
• AXIS_STRETCH_MODE_TILE = 1 --- Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system.
• AXIS_STRETCH_MODE_TILE_FIT = 2 --- Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system. Unlike :ref:`AXIS_STRETCH_MODE_TILE<class_StyleBoxTexture_constant_AXIS_STRETCH_MODE_TILE>`, the texture may be slightly stretched to make the nine-patch texture tile seamlessly.

Property Descriptions

• :ref:`AxisStretchMode<enum_StyleBoxTexture_AxisStretchMode>` axis_stretch_horizontal

Default	0
Setter	set_h_axis_stretch_mode(value)
Getter	get_h_axis_stretch_mode()

Controls how the stylebox's texture will be stretched or tiled horizontally. See :ref:`AxisStretchMode<enum_StyleBoxTexture_AxisStretchMode>` for possible values.

---

• :ref:`AxisStretchMode<enum_StyleBoxTexture_AxisStretchMode>` axis_stretch_vertical

Default	0
Setter	set_v_axis_stretch_mode(value)
Getter	get_v_axis_stretch_mode()

Controls how the stylebox's texture will be stretched or tiled vertically. See :ref:`AxisStretchMode<enum_StyleBoxTexture_AxisStretchMode>` for possible values.

---

• :ref:`bool<class_bool>` draw_center

Default	true
Setter	set_draw_center(value)
Getter	is_draw_center_enabled()

If true, the nine-patch texture's center tile will be drawn.

---

• :ref:`float<class_float>` expand_margin_bottom

Default	0.0
Setter	set_expand_margin_size(value)
Getter	get_expand_margin_size()

Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested.

---

• :ref:`float<class_float>` expand_margin_left

Default	0.0
Setter	set_expand_margin_size(value)
Getter	get_expand_margin_size()

Expands the left margin of this style box when drawing, causing it to be drawn larger than requested.

---

• :ref:`float<class_float>` expand_margin_right

Default	0.0
Setter	set_expand_margin_size(value)
Getter	get_expand_margin_size()

Expands the right margin of this style box when drawing, causing it to be drawn larger than requested.

---

• :ref:`float<class_float>` expand_margin_top

Default	0.0
Setter	set_expand_margin_size(value)
Getter	get_expand_margin_size()

Expands the top margin of this style box when drawing, causing it to be drawn larger than requested.

---

• :ref:`float<class_float>` margin_bottom

Default	0.0
Setter	set_margin_size(value)
Getter	get_margin_size()

Increases the bottom margin of the 3×3 texture box.

A higher value means more of the source texture is considered to be part of the bottom border of the 3×3 box.

This is also the value used as fallback for :ref:`StyleBox.content_margin_bottom<class_StyleBox_property_content_margin_bottom>` if it is negative.

---

• :ref:`float<class_float>` margin_left

Default	0.0
Setter	set_margin_size(value)
Getter	get_margin_size()

Increases the left margin of the 3×3 texture box.

A higher value means more of the source texture is considered to be part of the left border of the 3×3 box.

This is also the value used as fallback for :ref:`StyleBox.content_margin_left<class_StyleBox_property_content_margin_left>` if it is negative.

---

• :ref:`float<class_float>` margin_right

Default	0.0
Setter	set_margin_size(value)
Getter	get_margin_size()

Increases the right margin of the 3×3 texture box.

A higher value means more of the source texture is considered to be part of the right border of the 3×3 box.

This is also the value used as fallback for :ref:`StyleBox.content_margin_right<class_StyleBox_property_content_margin_right>` if it is negative.

---

• :ref:`float<class_float>` margin_top

Default	0.0
Setter	set_margin_size(value)
Getter	get_margin_size()

Increases the top margin of the 3×3 texture box.

A higher value means more of the source texture is considered to be part of the top border of the 3×3 box.

This is also the value used as fallback for :ref:`StyleBox.content_margin_top<class_StyleBox_property_content_margin_top>` if it is negative.

---

• :ref:`Color<class_Color>` modulate_color

Default	Color( 1, 1, 1, 1 )
Setter	set_modulate(value)
Getter	get_modulate()

Modulates the color of the texture when this style box is drawn.

---

• :ref:`Texture2D<class_Texture2D>` normal_map

Setter	set_normal_map(value)
Getter	get_normal_map()

The normal map to use when drawing this style box.

---

• :ref:`Rect2<class_Rect2>` region_rect

Default	Rect2( 0, 0, 0, 0 )
Setter	set_region_rect(value)
Getter	get_region_rect()

Species a sub-region of the texture to use.

This is equivalent to first wrapping the texture in an :ref:`AtlasTexture<class_AtlasTexture>` with the same region.

---

• :ref:`Texture2D<class_Texture2D>` texture

Setter	set_texture(value)
Getter	get_texture()

The texture to use when drawing this style box.

Method Descriptions

• :ref:`float<class_float>` get_expand_margin_size ( :ref:`Margin<enum_@GlobalScope_Margin>` margin ) const

Returns the size of the given margin's expand margin. See :ref:`Margin<enum_@GlobalScope_Margin>` for possible values.

---

• :ref:`float<class_float>` get_margin_size ( :ref:`Margin<enum_@GlobalScope_Margin>` margin ) const

Returns the size of the given margin. See :ref:`Margin<enum_@GlobalScope_Margin>` for possible values.

---

• void set_expand_margin_all ( :ref:`float<class_float>` size )

Sets the expand margin to size pixels for all margins.

---

• void set_expand_margin_individual ( :ref:`float<class_float>` size_left, :ref:`float<class_float>` size_top, :ref:`float<class_float>` size_right, :ref:`float<class_float>` size_bottom )

Sets the expand margin for each margin to size_left, size_top, size_right, and size_bottom pixels.

---

• void set_expand_margin_size ( :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` size )

Sets the expand margin to size pixels for the given margin. See :ref:`Margin<enum_@GlobalScope_Margin>` for possible values.

---

• void set_margin_size ( :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` size )

Sets the margin to size pixels for the given margin. See :ref:`Margin<enum_@GlobalScope_Margin>` for possible values.