godot-docs/classes/class_texturelayered.rst

.. 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>`

**Category:** Core

Brief Description
-----------------



Properties
----------

+-------------------------------------+------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`data<class_TextureLayered_data>`   |
+-------------------------------------+------------------------------------------+
| :ref:`int<class_int>`               | :ref:`flags<class_TextureLayered_flags>` |
+-------------------------------------+------------------------------------------+

Methods
-------

+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`create<class_TextureLayered_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_get_depth>` **(** **)** const                                                                                                                                                                      |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Format<enum_Image_Format>`  | :ref:`get_format<class_TextureLayered_get_format>` **(** **)** const                                                                                                                                                                    |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`             | :ref:`get_height<class_TextureLayered_get_height>` **(** **)** const                                                                                                                                                                    |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_Image>`         | :ref:`get_layer_data<class_TextureLayered_get_layer_data>` **(** :ref:`int<class_int>` layer **)** const                                                                                                                                |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`             | :ref:`get_width<class_TextureLayered_get_width>` **(** **)** const                                                                                                                                                                      |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                              | :ref:`set_data_partial<class_TextureLayered_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_set_layer_data>` **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)**                                                                                                     |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

.. _enum_TextureLayered_Flags:

enum **Flags**:

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

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

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

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

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

.. _class_TextureLayered_data:

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

.. _class_TextureLayered_flags:

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

+----------+------------------+
| *Setter* | set_flags(value) |
+----------+------------------+
| *Getter* | get_flags()      |
+----------+------------------+

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

.. _class_TextureLayered_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_get_depth:

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

.. _class_TextureLayered_get_format:

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

.. _class_TextureLayered_get_height:

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

.. _class_TextureLayered_get_layer_data:

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

.. _class_TextureLayered_get_width:

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

.. _class_TextureLayered_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_set_layer_data:

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