godot-docs/classes/class_texturerect.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the TextureRect.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_TextureRect:

TextureRect
===========

**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

Control for drawing textures.

Description
-----------

Used to draw icons and sprites in a user interface. The texture's placement can be controlled with the :ref:`stretch_mode<class_TextureRect_property_stretch_mode>` property. It can scale, tile, or stay centered inside its bounding rectangle.

Tutorials
---------

- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`__

Properties
----------

+--------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                          | :ref:`flip_h<class_TextureRect_property_flip_h>`                           | ``false``                                                             |
+--------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                          | :ref:`flip_v<class_TextureRect_property_flip_v>`                           | ``false``                                                             |
+--------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                          | :ref:`ignore_texture_size<class_TextureRect_property_ignore_texture_size>` | ``false``                                                             |
+--------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`MouseFilter<enum_Control_MouseFilter>`     | mouse_filter                                                               | ``1`` (overrides :ref:`Control<class_Control_property_mouse_filter>`) |
+--------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`StretchMode<enum_TextureRect_StretchMode>` | :ref:`stretch_mode<class_TextureRect_property_stretch_mode>`               | ``0``                                                                 |
+--------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>`                | :ref:`texture<class_TextureRect_property_texture>`                         |                                                                       |
+--------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------+

Enumerations
------------

.. _enum_TextureRect_StretchMode:

.. _class_TextureRect_constant_STRETCH_SCALE:

.. _class_TextureRect_constant_STRETCH_TILE:

.. _class_TextureRect_constant_STRETCH_KEEP:

.. _class_TextureRect_constant_STRETCH_KEEP_CENTERED:

.. _class_TextureRect_constant_STRETCH_KEEP_ASPECT:

.. _class_TextureRect_constant_STRETCH_KEEP_ASPECT_CENTERED:

.. _class_TextureRect_constant_STRETCH_KEEP_ASPECT_COVERED:

enum **StretchMode**:

- **STRETCH_SCALE** = **0** --- Scale to fit the node's bounding rectangle.

- **STRETCH_TILE** = **1** --- Tile inside the node's bounding rectangle.

- **STRETCH_KEEP** = **2** --- The texture keeps its original size and stays in the bounding rectangle's top-left corner.

- **STRETCH_KEEP_CENTERED** = **3** --- The texture keeps its original size and stays centered in the node's bounding rectangle.

- **STRETCH_KEEP_ASPECT** = **4** --- Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio.

- **STRETCH_KEEP_ASPECT_CENTERED** = **5** --- Scale the texture to fit the node's bounding rectangle, center it and maintain its aspect ratio.

- **STRETCH_KEEP_ASPECT_COVERED** = **6** --- Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits.

Property Descriptions
---------------------

.. _class_TextureRect_property_flip_h:

- :ref:`bool<class_bool>` **flip_h**

+-----------+-------------------+
| *Default* | ``false``         |
+-----------+-------------------+
| *Setter*  | set_flip_h(value) |
+-----------+-------------------+
| *Getter*  | is_flipped_h()    |
+-----------+-------------------+

If ``true``, texture is flipped horizontally.

----

.. _class_TextureRect_property_flip_v:

- :ref:`bool<class_bool>` **flip_v**

+-----------+-------------------+
| *Default* | ``false``         |
+-----------+-------------------+
| *Setter*  | set_flip_v(value) |
+-----------+-------------------+
| *Getter*  | is_flipped_v()    |
+-----------+-------------------+

If ``true``, texture is flipped vertically.

----

.. _class_TextureRect_property_ignore_texture_size:

- :ref:`bool<class_bool>` **ignore_texture_size**

+-----------+--------------------------------+
| *Default* | ``false``                      |
+-----------+--------------------------------+
| *Setter*  | set_ignore_texture_size(value) |
+-----------+--------------------------------+
| *Getter*  | get_ignore_texture_size()      |
+-----------+--------------------------------+

If ``true``, the size of the texture won't be considered for minimum size calculation, so the ``TextureRect`` can be shrunk down past the texture size. Useful for preventing ``TextureRect``\ s from breaking GUI layout regardless of their texture size.

----

.. _class_TextureRect_property_stretch_mode:

- :ref:`StretchMode<enum_TextureRect_StretchMode>` **stretch_mode**

+-----------+-------------------------+
| *Default* | ``0``                   |
+-----------+-------------------------+
| *Setter*  | set_stretch_mode(value) |
+-----------+-------------------------+
| *Getter*  | get_stretch_mode()      |
+-----------+-------------------------+

Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode<enum_TextureRect_StretchMode>`.

----

.. _class_TextureRect_property_texture:

- :ref:`Texture2D<class_Texture2D>` **texture**

+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture()      |
+----------+--------------------+

The node's :ref:`Texture2D<class_Texture2D>` resource.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`