Inheritance #

StyleBoxTexture #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

A texture-based nine-patch StyleBox.

A texture-based nine-patch StyleBox, in a way similar to 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.

Members #

var axis_stretch_horizontal = AXIS_STRETCH_MODE_STRETCH#

Controls how the stylebox's texture will be stretched or tiled horizontally. See AxisStretchMode for possible values.

var axis_stretch_vertical = AXIS_STRETCH_MODE_STRETCH#

Controls how the stylebox's texture will be stretched or tiled vertically. See AxisStretchMode for possible values.

var draw_center: bool = true#

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

var expand_margin_bottom: float = 0.0#

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

var expand_margin_left: float = 0.0#

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

var expand_margin_right: float = 0.0#

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

var expand_margin_top: float = 0.0#

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

var modulate_color: Color = Color(1, 1, 1, 1)#

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

var region_rect: Rect2 = Rect2(0, 0, 0, 0)#

The region to use from the texture.

This is equivalent to first wrapping the texture in an AtlasTexture with the same region.

If empty (Rect2(0, 0, 0, 0)), the whole texture is used.

var texture: Texture2D#

The texture to use when drawing this style box.

var texture_margin_bottom: float = 0.0#

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 StyleBox.content_margin_bottom if it is negative.

var texture_margin_left: float = 0.0#

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 StyleBox.content_margin_left if it is negative.

var texture_margin_right: float = 0.0#

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 StyleBox.content_margin_right if it is negative.

var texture_margin_top: float = 0.0#

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 StyleBox.content_margin_top if it is negative.

Methods #

Annotations #

Constants #

const AXIS_STRETCH_MODE_STRETCH = 0 enum AxisStretchMode#

Stretch the stylebox's texture. This results in visible distortion unless the texture size matches the stylebox's size perfectly.

const AXIS_STRETCH_MODE_TILE = 1 enum AxisStretchMode#

Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system.

const AXIS_STRETCH_MODE_TILE_FIT = 2 enum AxisStretchMode#

Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system. Unlike AXIS_STRETCH_MODE_TILE, the texture may be slightly stretched to make the nine-patch texture tile seamlessly.

Constructors #

Enums #

AxisStretchMode#

Operators #

Signals #

Theme Items #

Tutorials #