:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxTexture.xml. .. _class_StyleBoxTexture: StyleBoxTexture =============== **Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A texture-based nine-patch :ref:`StyleBox`. .. rst-class:: classref-introduction-group Description ----------- A texture-based nine-patch :ref:`StyleBox`, in a way similar to :ref:`NinePatchRect`. This stylebox performs a 3×3 scaling of a texture, where only the center cell is fully stretched. This makes it possible to design bordered styles regardless of the stylebox's size. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`AxisStretchMode` | :ref:`axis_stretch_horizontal` | ``0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`AxisStretchMode` | :ref:`axis_stretch_vertical` | ``0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`draw_center` | ``true`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`expand_margin_bottom` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`expand_margin_left` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`expand_margin_right` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`expand_margin_top` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`modulate_color` | ``Color(1, 1, 1, 1)`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`Rect2` | :ref:`region_rect` | ``Rect2(0, 0, 0, 0)`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`texture` | | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`texture_margin_bottom` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`texture_margin_left` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`texture_margin_right` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`texture_margin_top` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_expand_margin`\ (\ margin\: :ref:`Side`\ ) |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_texture_margin`\ (\ margin\: :ref:`Side`\ ) |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_expand_margin`\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_expand_margin_all`\ (\ size\: :ref:`float`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_texture_margin`\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_texture_margin_all`\ (\ size\: :ref:`float`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_StyleBoxTexture_AxisStretchMode: .. rst-class:: classref-enumeration enum **AxisStretchMode**: :ref:`🔗` .. _class_StyleBoxTexture_constant_AXIS_STRETCH_MODE_STRETCH: .. rst-class:: classref-enumeration-constant :ref:`AxisStretchMode` **AXIS_STRETCH_MODE_STRETCH** = ``0`` Stretch the stylebox's texture. This results in visible distortion unless the texture size matches the stylebox's size perfectly. .. _class_StyleBoxTexture_constant_AXIS_STRETCH_MODE_TILE: .. rst-class:: classref-enumeration-constant :ref:`AxisStretchMode` **AXIS_STRETCH_MODE_TILE** = ``1`` Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system. .. _class_StyleBoxTexture_constant_AXIS_STRETCH_MODE_TILE_FIT: .. rst-class:: classref-enumeration-constant :ref:`AxisStretchMode` **AXIS_STRETCH_MODE_TILE_FIT** = ``2`` Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system. Unlike :ref:`AXIS_STRETCH_MODE_TILE`, the texture may be slightly stretched to make the nine-patch texture tile seamlessly. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_StyleBoxTexture_property_axis_stretch_horizontal: .. rst-class:: classref-property :ref:`AxisStretchMode` **axis_stretch_horizontal** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_h_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) - :ref:`AxisStretchMode` **get_h_axis_stretch_mode**\ (\ ) Controls how the stylebox's texture will be stretched or tiled horizontally. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_axis_stretch_vertical: .. rst-class:: classref-property :ref:`AxisStretchMode` **axis_stretch_vertical** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_v_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) - :ref:`AxisStretchMode` **get_v_axis_stretch_mode**\ (\ ) Controls how the stylebox's texture will be stretched or tiled vertically. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_draw_center: .. rst-class:: classref-property :ref:`bool` **draw_center** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_draw_center**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_draw_center_enabled**\ (\ ) If ``true``, the nine-patch texture's center tile will be drawn. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_expand_margin_bottom: .. rst-class:: classref-property :ref:`float` **expand_margin_bottom** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) - :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_expand_margin_left: .. rst-class:: classref-property :ref:`float` **expand_margin_left** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) - :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the left margin of this style box when drawing, causing it to be drawn larger than requested. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_expand_margin_right: .. rst-class:: classref-property :ref:`float` **expand_margin_right** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) - :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the right margin of this style box when drawing, causing it to be drawn larger than requested. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_expand_margin_top: .. rst-class:: classref-property :ref:`float` **expand_margin_top** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) - :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the top margin of this style box when drawing, causing it to be drawn larger than requested. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_modulate_color: .. rst-class:: classref-property :ref:`Color` **modulate_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_modulate**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_modulate**\ (\ ) Modulates the color of the texture when this style box is drawn. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_region_rect: .. rst-class:: classref-property :ref:`Rect2` **region_rect** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_region_rect**\ (\ value\: :ref:`Rect2`\ ) - :ref:`Rect2` **get_region_rect**\ (\ ) The region to use from the :ref:`texture`. This is equivalent to first wrapping the :ref:`texture` in an :ref:`AtlasTexture` with the same region. If empty (``Rect2(0, 0, 0, 0)``), the whole :ref:`texture` is used. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_texture: .. rst-class:: classref-property :ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) - :ref:`Texture2D` **get_texture**\ (\ ) The texture to use when drawing this style box. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_texture_margin_bottom: .. rst-class:: classref-property :ref:`float` **texture_margin_bottom** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) - :ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| Increases the bottom margin of the 3×3 texture box. A higher value means more of the source texture is considered to be part of the bottom border of the 3×3 box. This is also the value used as fallback for :ref:`StyleBox.content_margin_bottom` if it is negative. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_texture_margin_left: .. rst-class:: classref-property :ref:`float` **texture_margin_left** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) - :ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| Increases the left margin of the 3×3 texture box. A higher value means more of the source texture is considered to be part of the left border of the 3×3 box. This is also the value used as fallback for :ref:`StyleBox.content_margin_left` if it is negative. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_texture_margin_right: .. rst-class:: classref-property :ref:`float` **texture_margin_right** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) - :ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| Increases the right margin of the 3×3 texture box. A higher value means more of the source texture is considered to be part of the right border of the 3×3 box. This is also the value used as fallback for :ref:`StyleBox.content_margin_right` if it is negative. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_property_texture_margin_top: .. rst-class:: classref-property :ref:`float` **texture_margin_top** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) - :ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| Increases the top margin of the 3×3 texture box. A higher value means more of the source texture is considered to be part of the top border of the 3×3 box. This is also the value used as fallback for :ref:`StyleBox.content_margin_top` if it is negative. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_StyleBoxTexture_method_get_expand_margin: .. rst-class:: classref-method :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the expand margin size of the specified :ref:`Side`. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_method_get_texture_margin: .. rst-class:: classref-method :ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| :ref:`🔗` Returns the margin size of the specified :ref:`Side`. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_method_set_expand_margin: .. rst-class:: classref-method |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) :ref:`🔗` Sets the expand margin to ``size`` pixels for the specified :ref:`Side`. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_method_set_expand_margin_all: .. rst-class:: classref-method |void| **set_expand_margin_all**\ (\ size\: :ref:`float`\ ) :ref:`🔗` Sets the expand margin to ``size`` pixels for all sides. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_method_set_texture_margin: .. rst-class:: classref-method |void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) :ref:`🔗` Sets the margin to ``size`` pixels for the specified :ref:`Side`. .. rst-class:: classref-item-separator ---- .. _class_StyleBoxTexture_method_set_texture_margin_all: .. rst-class:: classref-method |void| **set_texture_margin_all**\ (\ size\: :ref:`float`\ ) :ref:`🔗` Sets the margin to ``size`` pixels for all sides. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`