class_styleboxtexture.rst 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the StyleBoxTexture.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_StyleBoxTexture:
  5. StyleBoxTexture
  6. ===============
  7. **Inherits:** :ref:`StyleBox<class_stylebox>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Texture Based 3x3 scale style.
  12. Member Functions
  13. ----------------
  14. +-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`set_expand_margin_all<class_StyleBoxTexture_set_expand_margin_all>` **(** :ref:`float<class_float>` size **)** |
  16. +-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | 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 **)** |
  18. +-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. Signals
  20. -------
  21. .. _class_StyleBoxTexture_texture_changed:
  22. - **texture_changed** **(** **)**
  23. Member Variables
  24. ----------------
  25. .. _class_StyleBoxTexture_axis_stretch_horizontal:
  26. - :ref:`AxisStretchMode<enum_styleboxtexture_axisstretchmode>` **axis_stretch_horizontal**
  27. .. _class_StyleBoxTexture_axis_stretch_vertical:
  28. - :ref:`AxisStretchMode<enum_styleboxtexture_axisstretchmode>` **axis_stretch_vertical**
  29. .. _class_StyleBoxTexture_draw_center:
  30. - :ref:`bool<class_bool>` **draw_center**
  31. .. _class_StyleBoxTexture_expand_margin_bottom:
  32. - :ref:`float<class_float>` **expand_margin_bottom**
  33. .. _class_StyleBoxTexture_expand_margin_left:
  34. - :ref:`float<class_float>` **expand_margin_left**
  35. .. _class_StyleBoxTexture_expand_margin_right:
  36. - :ref:`float<class_float>` **expand_margin_right**
  37. .. _class_StyleBoxTexture_expand_margin_top:
  38. - :ref:`float<class_float>` **expand_margin_top**
  39. .. _class_StyleBoxTexture_margin_bottom:
  40. - :ref:`float<class_float>` **margin_bottom**
  41. .. _class_StyleBoxTexture_margin_left:
  42. - :ref:`float<class_float>` **margin_left**
  43. .. _class_StyleBoxTexture_margin_right:
  44. - :ref:`float<class_float>` **margin_right**
  45. .. _class_StyleBoxTexture_margin_top:
  46. - :ref:`float<class_float>` **margin_top**
  47. .. _class_StyleBoxTexture_modulate_color:
  48. - :ref:`Color<class_color>` **modulate_color**
  49. .. _class_StyleBoxTexture_normal_map:
  50. - :ref:`Resource<class_resource>` **normal_map**
  51. .. _class_StyleBoxTexture_region_rect:
  52. - :ref:`Rect2<class_rect2>` **region_rect**
  53. .. _class_StyleBoxTexture_texture:
  54. - :ref:`Resource<class_resource>` **texture**
  55. Enums
  56. -----
  57. .. _enum_StyleBoxTexture_AxisStretchMode:
  58. enum **AxisStretchMode**
  59. - **AXIS_STRETCH_MODE_STRETCH** = **0**
  60. - **AXIS_STRETCH_MODE_TILE** = **1**
  61. - **AXIS_STRETCH_MODE_TILE_FIT** = **2**
  62. Description
  63. -----------
  64. 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.
  65. Member Function Description
  66. ---------------------------
  67. .. _class_StyleBoxTexture_set_expand_margin_all:
  68. - void **set_expand_margin_all** **(** :ref:`float<class_float>` size **)**
  69. .. _class_StyleBoxTexture_set_expand_margin_individual:
  70. - 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 **)**