Class reference
NinePatchRect
Inherits Control
A control that displays a texture by keeping its corners intact, but tiling its edges and center.
Description
Also known as 9-slice panels, NinePatchRect produces clean panels of any size based on a small texture. To do so, it splits the texture in a 3×3 grid. When you scale the node, it tiles the texture's edges horizontally or vertically, tiles the center on both axes, and leaves the corners unchanged.
Properties
int axis_stretch_horizontal = 0
int axis_stretch_horizontal = 0The stretch mode to use for horizontal stretching/tiling.
int axis_stretch_vertical = 0
int axis_stretch_vertical = 0The stretch mode to use for vertical stretching/tiling.
bool draw_center = true
bool draw_center = trueIf true, draw the panel's center. Else, only draw the 9-slice's borders.
int mouse_filter = 2
int mouse_filter = 2int patch_margin_bottom = 0
int patch_margin_bottom = 0The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
int patch_margin_left = 0
int patch_margin_left = 0The width of the 9-slice's left column. A margin of 16 means the 9-slice's left corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
int patch_margin_right = 0
int patch_margin_right = 0The width of the 9-slice's right column. A margin of 16 means the 9-slice's right corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
int patch_margin_top = 0
int patch_margin_top = 0The height of the 9-slice's top row. A margin of 16 means the 9-slice's top corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
Rect2 region_rect = Rect2(0, 0, 0, 0)
Rect2 region_rect = Rect2(0, 0, 0, 0)Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. If the rect is empty, NinePatchRect will use the whole texture.
Texture2D texture
Texture2D textureThe node's texture resource.
Methods
Signals
texture_changed()
Emitted when the node's texture changes.
Constants
AXIS_STRETCH_MODE_STRETCH = 0
Stretches the center texture across the NinePatchRect. This may cause the texture to be distorted.
AXIS_STRETCH_MODE_TILE = 1
Repeats the center texture across the NinePatchRect. This won't cause any visible distortion. The texture must be seamless for this to work without displaying artifacts between edges.
AXIS_STRETCH_MODE_TILE_FIT = 2
Repeats the center texture across the NinePatchRect, but will also stretch the texture to make sure each tile is visible in full. This may cause the texture to be distorted, but less than AXIS_STRETCH_MODE_STRETCH. The texture must be seamless for this to work without displaying artifacts between edges.