godot-docs/classes/class_texturelayered.rst

:github_url: hide

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

.. _class_TextureLayered:

TextureLayered
==============

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`Texture3D<class_Texture3D>`, :ref:`TextureArray<class_TextureArray>`



Properties
----------

+-------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`data<class_TextureLayered_property_data>`   | ``{"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [  ],"width": 0}`` |
+-------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`flags<class_TextureLayered_property_flags>` | ``4``                                                                          |
+-------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------+

Methods
-------

+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`create<class_TextureLayered_method_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` flags=4 **)**                   |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_depth<class_TextureLayered_method_get_depth>` **(** **)** const                                                                                                                                                                      |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Format<enum_Image_Format>` | :ref:`get_format<class_TextureLayered_method_get_format>` **(** **)** const                                                                                                                                                                    |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_height<class_TextureLayered_method_get_height>` **(** **)** const                                                                                                                                                                    |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_Image>`        | :ref:`get_layer_data<class_TextureLayered_method_get_layer_data>` **(** :ref:`int<class_int>` layer **)** const                                                                                                                                |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_width<class_TextureLayered_method_get_width>` **(** **)** const                                                                                                                                                                      |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_data_partial<class_TextureLayered_method_set_data_partial>` **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` x_offset, :ref:`int<class_int>` y_offset, :ref:`int<class_int>` layer, :ref:`int<class_int>` mipmap=0 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_layer_data<class_TextureLayered_method_set_layer_data>` **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)**                                                                                                     |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

.. _enum_TextureLayered_Flags:

.. _class_TextureLayered_constant_FLAG_MIPMAPS:

.. _class_TextureLayered_constant_FLAG_REPEAT:

.. _class_TextureLayered_constant_FLAG_FILTER:

.. _class_TextureLayered_constant_FLAGS_DEFAULT:

enum **Flags**:

- **FLAG_MIPMAPS** = **1**

- **FLAG_REPEAT** = **2**

- **FLAG_FILTER** = **4**

- **FLAGS_DEFAULT** = **4**

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

.. _class_TextureLayered_property_data:

- :ref:`Dictionary<class_Dictionary>` **data**

+-----------+--------------------------------------------------------------------------------+
| *Default* | ``{"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [  ],"width": 0}`` |
+-----------+--------------------------------------------------------------------------------+

----

.. _class_TextureLayered_property_flags:

- :ref:`int<class_int>` **flags**

+-----------+------------------+
| *Default* | ``4``            |
+-----------+------------------+
| *Setter*  | set_flags(value) |
+-----------+------------------+
| *Getter*  | get_flags()      |
+-----------+------------------+

Method Descriptions
-------------------

.. _class_TextureLayered_method_create:

- void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` flags=4 **)**

----

.. _class_TextureLayered_method_get_depth:

- :ref:`int<class_int>` **get_depth** **(** **)** const

----

.. _class_TextureLayered_method_get_format:

- :ref:`Format<enum_Image_Format>` **get_format** **(** **)** const

----

.. _class_TextureLayered_method_get_height:

- :ref:`int<class_int>` **get_height** **(** **)** const

----

.. _class_TextureLayered_method_get_layer_data:

- :ref:`Image<class_Image>` **get_layer_data** **(** :ref:`int<class_int>` layer **)** const

----

.. _class_TextureLayered_method_get_width:

- :ref:`int<class_int>` **get_width** **(** **)** const

----

.. _class_TextureLayered_method_set_data_partial:

- void **set_data_partial** **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` x_offset, :ref:`int<class_int>` y_offset, :ref:`int<class_int>` layer, :ref:`int<class_int>` mipmap=0 **)**

----

.. _class_TextureLayered_method_set_layer_data:

- void **set_layer_data** **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)**