Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

StyleBoxTexture

Hérite de : StyleBox < Resource < RefCounted < Object

Une StyleBox à 9 sections basée sur une texture.

Description

Une StyleBox à 9 sections basée sur une texture, d'une manière semblable à NinePatchRect. Cette stylebox effectue un mise à l'échelle 3×3 d'une texture, où seule la cellule centrale est entièrement étirée. Cela permet de concevoir des styles à bordures indépendamment de la taille de la stylebox.

Propriétés

AxisStretchMode

axis_stretch_horizontal

0

AxisStretchMode

axis_stretch_vertical

0

bool

draw_center

true

float

expand_margin_bottom

0.0

float

expand_margin_left

0.0

float

expand_margin_right

0.0

float

expand_margin_top

0.0

Color

modulate_color

Color(1, 1, 1, 1)

Rect2

region_rect

Rect2(0, 0, 0, 0)

Texture2D

texture

float

texture_margin_bottom

0.0

float

texture_margin_left

0.0

float

texture_margin_right

0.0

float

texture_margin_top

0.0

Méthodes

float

get_expand_margin(margin: Side) const

float

get_texture_margin(margin: Side) const

void

set_expand_margin(margin: Side, size: float)

void

set_expand_margin_all(size: float)

void

set_texture_margin(margin: Side, size: float)

void

set_texture_margin_all(size: float)


Énumérations

enum AxisStretchMode: 🔗

AxisStretchMode AXIS_STRETCH_MODE_STRETCH = 0

Étire la texture de la boîte de style. Cela entraîne une distorsion visible à moins que la taille de la texture ne corresponde parfaitement à la taille de la boîte de style.

AxisStretchMode AXIS_STRETCH_MODE_TILE = 1

Répète la texture de la stylebox pour correspondre à la taille de la stylebox selon le système à 9 sections.

AxisStretchMode AXIS_STRETCH_MODE_TILE_FIT = 2

Répète la texture de la stylebox pour correspondre à la taille de la stylebox selon le système à 9 sections. Contrairement à AXIS_STRETCH_MODE_TILE, la texture peut être légèrement étirée pour répéter la texture à 9 sections sans coutures.


Descriptions des propriétés

AxisStretchMode axis_stretch_horizontal = 0 🔗

Contrôle la façon dont la texture de la stylebox sera étirée ou répétée horizontalement.


AxisStretchMode axis_stretch_vertical = 0 🔗

Contrôle la façon dont la texture de la stylebox sera étirée ou répétée verticalement.


bool draw_center = true 🔗

  • void set_draw_center(value: bool)

  • bool is_draw_center_enabled()

Si true, la tuile centrale de la texture à neuf sections sera dessinée.


float expand_margin_bottom = 0.0 🔗

  • void set_expand_margin(margin: Side, size: float)

  • float get_expand_margin(margin: Side) const

Augmente la marge du bas de cette boite de style lors de l'affichage, pour qu'elle soit plus grande que demandé.


float expand_margin_left = 0.0 🔗

  • void set_expand_margin(margin: Side, size: float)

  • float get_expand_margin(margin: Side) const

Augmente la marge gauche de cette boite de style lors de l'affichage, pour qu'elle soit plus grande que demandé.


float expand_margin_right = 0.0 🔗

  • void set_expand_margin(margin: Side, size: float)

  • float get_expand_margin(margin: Side) const

Augmente la marge droite de cette boite de style lors de l'affichage, pour qu'elle soit plus grande que demandé.


float expand_margin_top = 0.0 🔗

  • void set_expand_margin(margin: Side, size: float)

  • float get_expand_margin(margin: Side) const

Agrandit la marge supérieure de cette zone de style lors du dessin, la faisant être dessinée plus grande que demandé.


Color modulate_color = Color(1, 1, 1, 1) 🔗

  • void set_modulate(value: Color)

  • Color get_modulate()

Module la couleur de la texture lorsque cette boîte de style est dessinée.


Rect2 region_rect = Rect2(0, 0, 0, 0) 🔗

  • void set_region_rect(value: Rect2)

  • Rect2 get_region_rect()

La région à utiliser de texture.

Cela est équivalent à wrapper la texture dans une AtlasTexture avec la même région.

Si vide (Rect2(0, 0, 0, 0)), la texture entière est utilisée.


Texture2D texture 🔗

La texture à utiliser pour l'affichage de cette boite de style.


float texture_margin_bottom = 0.0 🔗

  • void set_texture_margin(margin: Side, size: float)

  • float get_texture_margin(margin: Side) const

Augmente la marge inférieure de la boîte de texture en 3×3.

Une valeur plus élevée signifie qu'une plus grande partie de la texture source est considérée comme faisant partie de la bordure inférieure de la boîte en 3×3.

C'est aussi la valeur de repli utilisée pour StyleBox.content_margin_bottom si elle est négative.


float texture_margin_left = 0.0 🔗

  • void set_texture_margin(margin: Side, size: float)

  • float get_texture_margin(margin: Side) const

Augmente la marge gauche de la boîte de texture en 3×3.

Une valeur plus élevée signifie qu'une plus grande partie de la texture source est considérée comme faisant partie de la bordure gauche de la boîte 3×3.

C'est aussi la valeur de repli utilisée pour StyleBox.content_margin_left si elle est négative.


float texture_margin_right = 0.0 🔗

  • void set_texture_margin(margin: Side, size: float)

  • float get_texture_margin(margin: Side) const

Augmente la marge droite de la boîte de texture en 3×3.

Une valeur plus élevée signifie qu'une plus grande partie de la texture source est considérée comme faisant partie de la droite frontière de la boîte 3×3.

C'est aussi la valeur de repli utilisée pour StyleBox.content_margin_right si elle est négative.


float texture_margin_top = 0.0 🔗

  • void set_texture_margin(margin: Side, size: float)

  • float get_texture_margin(margin: Side) const

Augmente la marge supérieure de la boîte de texture en 3×3.

Une valeur plus élevée signifie qu'une plus grande partie de la texture source est considérée comme faisant partie de la bordure supérieure de la boîte 3×3.

C'est aussi la valeur de repli utilisée pour StyleBox.content_margin_top si elle est négative.


Descriptions des méthodes

float get_expand_margin(margin: Side) const 🔗

Renvoie la taille de la marge d'extension du côté Side spécifié.


float get_texture_margin(margin: Side) const 🔗

Renvoie la taille de la marge du côté Side spécifié.


void set_expand_margin(margin: Side, size: float) 🔗

Définit la marge d'élargissement à size pixels pour le côté Side spécifié.


void set_expand_margin_all(size: float) 🔗

Définit la marge d'élargissement à size pixels pour tous les côtés.


void set_texture_margin(margin: Side, size: float) 🔗

Définit la marge à size pixels pour le côté Side spécifié.


void set_texture_margin_all(size: float) 🔗

Définit la marge à size pixels pour tous les côtés.