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.

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.

@GodotBaseClass

struct NinePatchRect {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(NinePatchRect other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static NinePatchRect _new();

enum AxisStretchMode;

enum Constants;

NinePatchRect.AxisStretchMode getHAxisStretchMode();

long getPatchMargin(long margin);

Rect2 getRegionRect();

Ref!Texture getTexture();

NinePatchRect.AxisStretchMode getVAxisStretchMode();

bool isDrawCenterEnabled();

void setDrawCenter(bool draw_center);

void setHAxisStretchMode(long mode);

void setPatchMargin(long margin, long value);

void setRegionRect(Rect2 rect);

void setTexture(Texture texture);

void setVAxisStretchMode(long mode);

NinePatchRect.AxisStretchMode axisStretchHorizontal [@property getter];

long axisStretchHorizontal [@property setter];

NinePatchRect.AxisStretchMode axisStretchVertical [@property getter];

long axisStretchVertical [@property setter];

bool drawCenter [@property getter];

bool drawCenter [@property setter];

long patchMarginBottom [@property getter];

long patchMarginBottom [@property setter];

long patchMarginLeft [@property getter];

long patchMarginLeft [@property setter];

long patchMarginRight [@property getter];

long patchMarginRight [@property setter];

long patchMarginTop [@property getter];

long patchMarginTop [@property setter];

Rect2 regionRect [@property getter];

Rect2 regionRect [@property setter];

Texture texture [@property getter];

Texture texture [@property setter];

}

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): Returns the size of the margin identified by the given margin constant.
getRegionRect Rect2 getRegionRect()
getTexture Ref!Texture getTexture()
getVAxisStretchMode NinePatchRect.AxisStretchMode getVAxisStretchMode()
isDrawCenterEnabled bool isDrawCenterEnabled()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(NinePatchRect other)
opEquals bool opEquals(typeof(null) n)
setDrawCenter void setDrawCenter(bool draw_center)
setHAxisStretchMode void setHAxisStretchMode(long mode)
setPatchMargin void setPatchMargin(long margin, long value): Sets the size of the margin identified by the given margin constant to value in pixels.
setRegionRect void setRegionRect(Rect2 rect)
setTexture void setTexture(Texture texture)
setVAxisStretchMode void setVAxisStretchMode(long mode)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

axisStretchHorizontal NinePatchRect.AxisStretchMode axisStretchHorizontal [@property getter]
long axisStretchHorizontal [@property setter]: The stretch mode to use for horizontal stretching/tiling. See NinePatchRect.axisstretchmode for possible values.
axisStretchVertical NinePatchRect.AxisStretchMode axisStretchVertical [@property getter]
long axisStretchVertical [@property setter]: The stretch mode to use for vertical stretching/tiling. See NinePatchRect.axisstretchmode for possible values.
drawCenter bool drawCenter [@property getter]
bool drawCenter [@property setter]: If true, draw the panel's center. Else, only draw the 9-slice's borders.
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 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.
patchMarginRight long patchMarginRight [@property getter]
long patchMarginRight [@property setter]: The 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.
patchMarginTop long patchMarginTop [@property getter]
long patchMarginTop [@property setter]: The 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.
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. If the rect is empty, NinePatchRect will use the whole texture.
texture Texture texture [@property getter]
Texture texture [@property setter]: The node's texture resource.

Static functions

_new NinePatchRect _new(): Construct a new instance of NinePatchRect. Note: use memnew!NinePatchRect instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: 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 inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(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

Source

See Implementation

godot ninepatchrect structs

NinePatchRect