Files
godot-docs/classes/class_styleboxtexture.rst
2018-09-13 01:56:47 +02:00

128 lines
4.2 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the StyleBoxTexture.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_StyleBoxTexture:
StyleBoxTexture
===============
**Inherits:** :ref:`StyleBox<class_StyleBox>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Texture Based 3x3 scale style.
Methods
-------
+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_expand_margin_all<class_StyleBoxTexture_set_expand_margin_all>` **(** :ref:`float<class_float>` size **)** |
+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_expand_margin_individual<class_StyleBoxTexture_set_expand_margin_individual>` **(** :ref:`float<class_float>` size_left, :ref:`float<class_float>` size_top, :ref:`float<class_float>` size_right, :ref:`float<class_float>` size_bottom **)** |
+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_StyleBoxTexture_texture_changed:
- **texture_changed** **(** **)**
Enumerations
------------
.. _enum_StyleBoxTexture_AxisStretchMode:
enum **AxisStretchMode**
- **AXIS_STRETCH_MODE_STRETCH** = **0**
- **AXIS_STRETCH_MODE_TILE** = **1**
- **AXIS_STRETCH_MODE_TILE_FIT** = **2**
Description
-----------
Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles.
Property Descriptions
---------------------
.. _class_StyleBoxTexture_axis_stretch_horizontal:
- :ref:`AxisStretchMode<enum_StyleBoxTexture_AxisStretchMode>` **axis_stretch_horizontal**
.. _class_StyleBoxTexture_axis_stretch_vertical:
- :ref:`AxisStretchMode<enum_StyleBoxTexture_AxisStretchMode>` **axis_stretch_vertical**
.. _class_StyleBoxTexture_draw_center:
- :ref:`bool<class_bool>` **draw_center**
.. _class_StyleBoxTexture_expand_margin_bottom:
- :ref:`float<class_float>` **expand_margin_bottom**
.. _class_StyleBoxTexture_expand_margin_left:
- :ref:`float<class_float>` **expand_margin_left**
.. _class_StyleBoxTexture_expand_margin_right:
- :ref:`float<class_float>` **expand_margin_right**
.. _class_StyleBoxTexture_expand_margin_top:
- :ref:`float<class_float>` **expand_margin_top**
.. _class_StyleBoxTexture_margin_bottom:
- :ref:`float<class_float>` **margin_bottom**
.. _class_StyleBoxTexture_margin_left:
- :ref:`float<class_float>` **margin_left**
.. _class_StyleBoxTexture_margin_right:
- :ref:`float<class_float>` **margin_right**
.. _class_StyleBoxTexture_margin_top:
- :ref:`float<class_float>` **margin_top**
.. _class_StyleBoxTexture_modulate_color:
- :ref:`Color<class_Color>` **modulate_color**
.. _class_StyleBoxTexture_normal_map:
- :ref:`Texture<class_Texture>` **normal_map**
.. _class_StyleBoxTexture_region_rect:
- :ref:`Rect2<class_Rect2>` **region_rect**
.. _class_StyleBoxTexture_texture:
- :ref:`Texture<class_Texture>` **texture**
Method Descriptions
-------------------
.. _class_StyleBoxTexture_set_expand_margin_all:
- void **set_expand_margin_all** **(** :ref:`float<class_float>` size **)**
.. _class_StyleBoxTexture_set_expand_margin_individual:
- void **set_expand_margin_individual** **(** :ref:`float<class_float>` size_left, :ref:`float<class_float>` size_top, :ref:`float<class_float>` size_right, :ref:`float<class_float>` size_bottom **)**