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.

    Properties

    get_patch_margin ( margin ) const
    voidset_patch_margin ( margin, int value )

    Signals

    • texture_changed ( )

    Emitted when the node’s texture changes.

    enum AxisStretchMode:

    • 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.

    Note: Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like .

    • 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.

    Property Descriptions

    • axis_stretch_horizontal
    Default0
    Setterset_h_axis_stretch_mode(value)
    Getterget_h_axis_stretch_mode()

    The stretch mode to use for horizontal stretching/tiling. See AxisStretchMode for possible values.

    • axis_stretch_vertical

    The stretch mode to use for vertical stretching/tiling. See AxisStretchMode for possible values.

    Defaulttrue
    Setterset_draw_center(value)
    Getteris_draw_center_enabled()

    If , draw the panel’s center. Else, only draw the 9-slice’s borders.

    • patch_margin_bottom
    Default0
    Setterset_patch_margin(value)
    Getterget_patch_margin()

    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.

    • int patch_margin_left

    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.

    • patch_margin_right
    Default0
    Setterset_patch_margin(value)
    Getterget_patch_margin()
    • int patch_margin_top
    Default0
    Setterset_patch_margin(value)
    Getterget_patch_margin()

    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.

    • region_rect

    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.

    Setterset_texture(value)
    Getterget_texture()

    The node’s texture resource.

    Returns the size of the margin identified by the given constant.

    • void set_patch_margin ( Margin margin, value )

    Sets the size of the margin identified by the given Margin constant to in pixels.