godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-09-02 17:15:33 +02:00
parent e27f0c3cb8
commit 40cb5153bd
203 changed files with 6302 additions and 5188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
classes/class_styleboxtexture.rst
View File

@@ -18,35 +18,47 @@ Texture Based 3x3 scale style.
Member Functions
----------------
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_draw_center<class_StyleBoxTexture_get_draw_center>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_expand_margin_size<class_StyleBoxTexture_get_expand_margin_size>` **(** :ref:`int<class_int>` margin **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_margin_size<class_StyleBoxTexture_get_margin_size>` **(** :ref:`int<class_int>` margin **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_modulate<class_StyleBoxTexture_get_modulate>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_normal_map<class_StyleBoxTexture_get_normal_map>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_region_rect<class_StyleBoxTexture_get_region_rect>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_StyleBoxTexture_get_texture>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_center<class_StyleBoxTexture_set_draw_center>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_expand_margin_size<class_StyleBoxTexture_set_expand_margin_size>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_margin_size<class_StyleBoxTexture_set_margin_size>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_modulate<class_StyleBoxTexture_set_modulate>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal_map<class_StyleBoxTexture_set_normal_map>` **(** :ref:`Texture<class_texture>` normal_map **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_region_rect<class_StyleBoxTexture_set_region_rect>` **(** :ref:`Rect2<class_rect2>` region **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_StyleBoxTexture_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_expand_margin_size<class_StyleBoxTexture_get_expand_margin_size>` **(** :ref:`int<class_int>` margin **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_h_axis_stretch_mode<class_StyleBoxTexture_get_h_axis_stretch_mode>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_margin_size<class_StyleBoxTexture_get_margin_size>` **(** :ref:`int<class_int>` margin **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_modulate<class_StyleBoxTexture_get_modulate>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Resource<class_resource>` | :ref:`get_normal_map<class_StyleBoxTexture_get_normal_map>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_region_rect<class_StyleBoxTexture_get_region_rect>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Resource<class_resource>` | :ref:`get_texture<class_StyleBoxTexture_get_texture>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_v_axis_stretch_mode<class_StyleBoxTexture_get_v_axis_stretch_mode>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_draw_center_enabled<class_StyleBoxTexture_is_draw_center_enabled>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_center<class_StyleBoxTexture_set_draw_center>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_expand_margin_size<class_StyleBoxTexture_set_expand_margin_size>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_axis_stretch_mode<class_StyleBoxTexture_set_h_axis_stretch_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_margin_size<class_StyleBoxTexture_set_margin_size>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_modulate<class_StyleBoxTexture_set_modulate>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal_map<class_StyleBoxTexture_set_normal_map>` **(** :ref:`Resource<class_resource>` normal_map **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_region_rect<class_StyleBoxTexture_set_region_rect>` **(** :ref:`Rect2<class_rect2>` region **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_StyleBoxTexture_set_texture>` **(** :ref:`Resource<class_resource>` texture **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_axis_stretch_mode<class_StyleBoxTexture_set_v_axis_stretch_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -56,6 +68,8 @@ Signals
Member Variables
----------------
- :ref:`int<class_int>` **axis_stretch_horizontal**
- :ref:`int<class_int>` **axis_stretch_vertical**
- :ref:`bool<class_bool>` **draw_center**
- :ref:`float<class_float>` **expand_margin_bottom**
- :ref:`float<class_float>` **expand_margin_left**
@@ -66,9 +80,16 @@ Member Variables
- :ref:`float<class_float>` **margin_right**
- :ref:`float<class_float>` **margin_top**
- :ref:`Color<class_color>` **modulate_color**
- :ref:`Texture<class_texture>` **normal_map**
- :ref:`Resource<class_resource>` **normal_map**
- :ref:`Rect2<class_rect2>` **region_rect**
- :ref:`Texture<class_texture>` **texture**
- :ref:`Resource<class_resource>` **texture**
Numeric Constants
-----------------
- **AXIS_STRETCH_MODE_STRETCH** = **0**
- **AXIS_STRETCH_MODE_TILE** = **1**
- **AXIS_STRETCH_MODE_TILE_FIT** = **2**
Description
-----------
@@ -78,14 +99,14 @@ Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture
Member Function Description
---------------------------
.. _class_StyleBoxTexture_get_draw_center:
- :ref:`bool<class_bool>` **get_draw_center** **(** **)** const
.. _class_StyleBoxTexture_get_expand_margin_size:
- :ref:`float<class_float>` **get_expand_margin_size** **(** :ref:`int<class_int>` margin **)** const
.. _class_StyleBoxTexture_get_h_axis_stretch_mode:
- :ref:`int<class_int>` **get_h_axis_stretch_mode** **(** **)** const
.. _class_StyleBoxTexture_get_margin_size:
- :ref:`float<class_float>` **get_margin_size** **(** :ref:`int<class_int>` margin **)** const
@@ -96,7 +117,7 @@ Member Function Description
.. _class_StyleBoxTexture_get_normal_map:
- :ref:`Texture<class_texture>` **get_normal_map** **(** **)** const
- :ref:`Resource<class_resource>` **get_normal_map** **(** **)** const
.. _class_StyleBoxTexture_get_region_rect:
@@ -104,16 +125,36 @@ Member Function Description
.. _class_StyleBoxTexture_get_texture:
- :ref:`Texture<class_texture>` **get_texture** **(** **)** const
- :ref:`Resource<class_resource>` **get_texture** **(** **)** const
.. _class_StyleBoxTexture_get_v_axis_stretch_mode:
- :ref:`int<class_int>` **get_v_axis_stretch_mode** **(** **)** const
.. _class_StyleBoxTexture_is_draw_center_enabled:
- :ref:`bool<class_bool>` **is_draw_center_enabled** **(** **)** const
.. _class_StyleBoxTexture_set_draw_center:
- void **set_draw_center** **(** :ref:`bool<class_bool>` enable **)**
.. _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 **)**
.. _class_StyleBoxTexture_set_expand_margin_size:
- void **set_expand_margin_size** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)**
.. _class_StyleBoxTexture_set_h_axis_stretch_mode:
- void **set_h_axis_stretch_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_StyleBoxTexture_set_margin_size:
- void **set_margin_size** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)**
@@ -124,7 +165,7 @@ Member Function Description
.. _class_StyleBoxTexture_set_normal_map:
- void **set_normal_map** **(** :ref:`Texture<class_texture>` normal_map **)**
- void **set_normal_map** **(** :ref:`Resource<class_resource>` normal_map **)**
.. _class_StyleBoxTexture_set_region_rect:
@@ -132,6 +173,10 @@ Member Function Description
.. _class_StyleBoxTexture_set_texture:
- void **set_texture** **(** :ref:`Texture<class_texture>` texture **)**
- void **set_texture** **(** :ref:`Resource<class_resource>` texture **)**
.. _class_StyleBoxTexture_set_v_axis_stretch_mode:
- void **set_v_axis_stretch_mode** **(** :ref:`int<class_int>` mode **)**