class_textureframe.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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_TextureFrame:
  4. TextureFrame
  5. ============
  6. **Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Control Frame that draws a texture.
  11. Member Functions
  12. ----------------
  13. +------------------------------+-------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`set_texture<class_TextureFrame_set_texture>` **(** :ref:`Object<class_object>` texture **)** |
  15. +------------------------------+-------------------------------------------------------------------------------------------------------+
  16. | :ref:`Object<class_object>` | :ref:`get_texture<class_TextureFrame_get_texture>` **(** **)** const |
  17. +------------------------------+-------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`set_modulate<class_TextureFrame_set_modulate>` **(** :ref:`Color<class_color>` modulate **)** |
  19. +------------------------------+-------------------------------------------------------------------------------------------------------+
  20. | :ref:`Color<class_color>` | :ref:`get_modulate<class_TextureFrame_get_modulate>` **(** **)** const |
  21. +------------------------------+-------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_expand<class_TextureFrame_set_expand>` **(** :ref:`bool<class_bool>` enable **)** |
  23. +------------------------------+-------------------------------------------------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`has_expand<class_TextureFrame_has_expand>` **(** **)** const |
  25. +------------------------------+-------------------------------------------------------------------------------------------------------+
  26. Description
  27. -----------
  28. Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI.
  29. Member Function Description
  30. ---------------------------
  31. .. _class_TextureFrame_set_texture:
  32. - void **set_texture** **(** :ref:`Object<class_object>` texture **)**
  33. .. _class_TextureFrame_get_texture:
  34. - :ref:`Object<class_object>` **get_texture** **(** **)** const
  35. .. _class_TextureFrame_set_modulate:
  36. - void **set_modulate** **(** :ref:`Color<class_color>` modulate **)**
  37. .. _class_TextureFrame_get_modulate:
  38. - :ref:`Color<class_color>` **get_modulate** **(** **)** const
  39. .. _class_TextureFrame_set_expand:
  40. - void **set_expand** **(** :ref:`bool<class_bool>` enable **)**
  41. .. _class_TextureFrame_has_expand:
  42. - :ref:`bool<class_bool>` **has_expand** **(** **)** const