class_styleboxtexture.rst 5.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_StyleBoxTexture:
  4. StyleBoxTexture
  5. ===============
  6. **Inherits:** :ref:`StyleBox<class_stylebox>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Texture Based 3x3 scale style.
  11. Member Functions
  12. ----------------
  13. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`bool<class_bool>` | :ref:`get_draw_center<class_StyleBoxTexture_get_draw_center>` **(** **)** const |
  15. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`get_expand_margin_size<class_StyleBoxTexture_get_expand_margin_size>` **(** :ref:`int<class_int>` margin **)** const |
  17. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`get_margin_size<class_StyleBoxTexture_get_margin_size>` **(** :ref:`int<class_int>` margin **)** const |
  19. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`Rect2<class_rect2>` | :ref:`get_region_rect<class_StyleBoxTexture_get_region_rect>` **(** **)** const |
  21. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`Texture<class_texture>` | :ref:`get_texture<class_StyleBoxTexture_get_texture>` **(** **)** const |
  23. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_draw_center<class_StyleBoxTexture_set_draw_center>` **(** :ref:`bool<class_bool>` enable **)** |
  25. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`set_expand_margin_size<class_StyleBoxTexture_set_expand_margin_size>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)** |
  27. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`set_margin_size<class_StyleBoxTexture_set_margin_size>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)** |
  29. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`set_region_rect<class_StyleBoxTexture_set_region_rect>` **(** :ref:`Rect2<class_rect2>` region **)** |
  31. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`set_texture<class_StyleBoxTexture_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
  33. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. Signals
  35. -------
  36. - **texture_changed** **(** **)**
  37. Description
  38. -----------
  39. 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.
  40. Member Function Description
  41. ---------------------------
  42. .. _class_StyleBoxTexture_get_draw_center:
  43. - :ref:`bool<class_bool>` **get_draw_center** **(** **)** const
  44. .. _class_StyleBoxTexture_get_expand_margin_size:
  45. - :ref:`float<class_float>` **get_expand_margin_size** **(** :ref:`int<class_int>` margin **)** const
  46. .. _class_StyleBoxTexture_get_margin_size:
  47. - :ref:`float<class_float>` **get_margin_size** **(** :ref:`int<class_int>` margin **)** const
  48. .. _class_StyleBoxTexture_get_region_rect:
  49. - :ref:`Rect2<class_rect2>` **get_region_rect** **(** **)** const
  50. .. _class_StyleBoxTexture_get_texture:
  51. - :ref:`Texture<class_texture>` **get_texture** **(** **)** const
  52. .. _class_StyleBoxTexture_set_draw_center:
  53. - void **set_draw_center** **(** :ref:`bool<class_bool>` enable **)**
  54. .. _class_StyleBoxTexture_set_expand_margin_size:
  55. - void **set_expand_margin_size** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)**
  56. .. _class_StyleBoxTexture_set_margin_size:
  57. - void **set_margin_size** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)**
  58. .. _class_StyleBoxTexture_set_region_rect:
  59. - void **set_region_rect** **(** :ref:`Rect2<class_rect2>` region **)**
  60. .. _class_StyleBoxTexture_set_texture:
  61. - void **set_texture** **(** :ref:`Texture<class_texture>` texture **)**