Files
godot-docs/classes/class_textureframe.rst
T
Rémi Verschelde 1204e3ea17 Add a warning header to each classref file
To tell potential contributors that they should NOT edit those files but instead should work on the class.xml source of the main Godot repo
2016-02-17 22:04:18 +01:00

68 lines
3.0 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_TextureFrame:
TextureFrame
============
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Control Frame that draws a texture.
Member Functions
----------------
+------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_TextureFrame_set_texture>` **(** :ref:`Object<class_object>` texture **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_texture<class_TextureFrame_get_texture>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_modulate<class_TextureFrame_set_modulate>` **(** :ref:`Color<class_color>` modulate **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_modulate<class_TextureFrame_get_modulate>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_expand<class_TextureFrame_set_expand>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_expand<class_TextureFrame_has_expand>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------+
Description
-----------
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.
Member Function Description
---------------------------
.. _class_TextureFrame_set_texture:
- void **set_texture** **(** :ref:`Object<class_object>` texture **)**
.. _class_TextureFrame_get_texture:
- :ref:`Object<class_object>` **get_texture** **(** **)** const
.. _class_TextureFrame_set_modulate:
- void **set_modulate** **(** :ref:`Color<class_color>` modulate **)**
.. _class_TextureFrame_get_modulate:
- :ref:`Color<class_color>` **get_modulate** **(** **)** const
.. _class_TextureFrame_set_expand:
- void **set_expand** **(** :ref:`bool<class_bool>` enable **)**
.. _class_TextureFrame_has_expand:
- :ref:`bool<class_bool>` **has_expand** **(** **)** const