Struct NinePatchRect

Scalable texture-based frame that tiles the texture's centers and sides, but keeps the corners' original size. Perfect for panels and dialog boxes.

struct NinePatchRect ;

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 sides horizontally or vertically, the center on both axes but it doesn't scale or tile the corners.

Properties

NameTypeDescription
axisStretchHorizontal[get, set] NinePatchRect.AxisStretchModeDoesn't do anything at the time of writing.
axisStretchVertical[get, set] NinePatchRect.AxisStretchModeDoesn't do anything at the time of writing.
drawCenter[get, set] boolIf true, draw the panel's center. Else, only draw the 9-slice's borders.
patchMarginBottom[get, set] longThe 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.
patchMarginLeft[get, set] longThe height of the 9-slice's left column.
patchMarginRight[get, set] longThe height of the 9-slice's right column.
patchMarginTop[get, set] longThe height of the 9-slice's top row.
regionRect[get, set] Rect2Rectangular 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.
texture[get, set] TextureThe node's texture resource.

Methods

NameDescription
getHAxisStretchMode
getPatchMargin Returns the size of the margin identified by the given margin constant.
getRegionRect
getTexture
getVAxisStretchMode
isDrawCenterEnabled
setDrawCenter
setHAxisStretchMode
setPatchMargin Sets the size of the margin identified by the given margin constant to value in pixels.
setRegionRect
setTexture
setVAxisStretchMode

Enums

NameDescription
AxisStretchMode
Constants