Index · Object → RefCounted → Resource → StyleBox → StyleBoxTexture

StyleBoxTexture

A texture-based nine-patch StyleBox.

Class Description

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.

Properties

var axis_stretch_horizontal: StyleBoxTexture.AxisStretchMode = 0

Controls how the stylebox's texture will be stretched or tiled horizontally.

var axis_stretch_vertical: StyleBoxTexture.AxisStretchMode = 0

Controls how the stylebox's texture will be stretched or tiled vertically.

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.

Inherited from StyleBox (4)
Inherited from Resource (4)

Methods

func get_expand_margin(margin: Side) -> float

Returns the expand margin size of the specified Side.

func get_texture_margin(margin: Side) -> float

Returns the margin size of the specified Side.

func set_expand_margin(margin: Side, size: float) -> void

Sets the expand margin to size pixels for the specified Side.

func set_expand_margin_all(size: float) -> void

Sets the expand margin to size pixels for all sides.

func set_texture_margin(margin: Side, size: float) -> void

Sets the margin to size pixels for the specified Side.

func set_texture_margin_all(size: float) -> void

Sets the margin to size pixels for all sides.

Inherited from StyleBox (13)
func _draw(to_canvas_item: RID, rect: Rect2) -> void
func _get_draw_rect(rect: Rect2) -> Rect2
func _test_mask(point: Vector2, rect: Rect2) -> bool
func draw(canvas_item: RID, rect: Rect2) -> void
func get_content_margin(margin: Side) -> float
func get_margin(margin: Side) -> float
func set_content_margin(margin: Side, offset: float) -> void
func set_content_margin_all(offset: float) -> void
func test_mask(point: Vector2, rect: Rect2) -> bool
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

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 AXIS_STRETCH_MODE_TILE, the texture may be slightly stretched to make the nine-patch texture tile seamlessly.