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.

Better 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 by 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.

@GodotBaseClass
struct NinePatchRect {}

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Enums

AxisStretchMode
enum AxisStretchMode
Constants
enum Constants

Functions

getHAxisStretchMode
NinePatchRect.AxisStretchMode getHAxisStretchMode()
getPatchMargin
long getPatchMargin(long margin)
getRegionRect
Rect2 getRegionRect()
getTexture
Ref!Texture getTexture()
getVAxisStretchMode
NinePatchRect.AxisStretchMode getVAxisStretchMode()
isDrawCenterEnabled
bool isDrawCenterEnabled()
opAssign
NinePatchRect opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(NinePatchRect other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setDrawCenter
void setDrawCenter(bool draw_center)
setHAxisStretchMode
void setHAxisStretchMode(long mode)
setPatchMargin
void setPatchMargin(long margin, long value)
setRegionRect
void setRegionRect(Rect2 rect)
setTexture
void setTexture(Texture texture)
setVAxisStretchMode
void setVAxisStretchMode(long mode)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

axisStretchHorizontal
long axisStretchHorizontal [@property setter]

Doesn't do anything at the time of writing.

axisStretchHorizontal
NinePatchRect.AxisStretchMode axisStretchHorizontal [@property getter]

Doesn't do anything at the time of writing.

axisStretchVertical
NinePatchRect.AxisStretchMode axisStretchVertical [@property getter]
long axisStretchVertical [@property setter]

Doesn't do anything at the time of writing.

drawCenter
bool drawCenter [@property getter]
bool drawCenter [@property setter]

If true, draw the panel's center. Else, only draw the 9-slice's borders. Default value: true

patchMarginBottom
long patchMarginBottom [@property getter]
long patchMarginBottom [@property setter]

The 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
long patchMarginLeft [@property getter]
long patchMarginLeft [@property setter]

The height of the 9-slice's left column.

patchMarginRight
long patchMarginRight [@property getter]
long patchMarginRight [@property setter]

The height of the 9-slice's right column.

patchMarginTop
long patchMarginTop [@property getter]
long patchMarginTop [@property setter]

The height of the 9-slice's top row.

regionRect
Rect2 regionRect [@property getter]
Rect2 regionRect [@property setter]

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.

texture
Texture texture [@property getter]
Texture texture [@property setter]

The node's texture resource.

Static functions

_new
NinePatchRect _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta