godot-docs/classes/class_rdtextureformat.rst

:github_url: hide

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

.. _class_RDTextureFormat:

RDTextureFormat
===============

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`



Properties
----------

+------------------------------------------------------------+------------------------------------------------------------------+-------+
| :ref:`int<class_int>`                                      | :ref:`array_layers<class_RDTextureFormat_property_array_layers>` | ``1`` |
+------------------------------------------------------------+------------------------------------------------------------------+-------+
| :ref:`int<class_int>`                                      | :ref:`depth<class_RDTextureFormat_property_depth>`               | ``1`` |
+------------------------------------------------------------+------------------------------------------------------------------+-------+
| :ref:`DataFormat<enum_RenderingDevice_DataFormat>`         | :ref:`format<class_RDTextureFormat_property_format>`             | ``8`` |
+------------------------------------------------------------+------------------------------------------------------------------+-------+
| :ref:`int<class_int>`                                      | :ref:`height<class_RDTextureFormat_property_height>`             | ``1`` |
+------------------------------------------------------------+------------------------------------------------------------------+-------+
| :ref:`int<class_int>`                                      | :ref:`mipmaps<class_RDTextureFormat_property_mipmaps>`           | ``1`` |
+------------------------------------------------------------+------------------------------------------------------------------+-------+
| :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` | :ref:`samples<class_RDTextureFormat_property_samples>`           | ``0`` |
+------------------------------------------------------------+------------------------------------------------------------------+-------+
| :ref:`TextureType<enum_RenderingDevice_TextureType>`       | :ref:`texture_type<class_RDTextureFormat_property_texture_type>` | ``1`` |
+------------------------------------------------------------+------------------------------------------------------------------+-------+
| :ref:`int<class_int>`                                      | :ref:`usage_bits<class_RDTextureFormat_property_usage_bits>`     | ``0`` |
+------------------------------------------------------------+------------------------------------------------------------------+-------+
| :ref:`int<class_int>`                                      | :ref:`width<class_RDTextureFormat_property_width>`               | ``1`` |
+------------------------------------------------------------+------------------------------------------------------------------+-------+

Methods
-------

+------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_shareable_format<class_RDTextureFormat_method_add_shareable_format>` **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format **)**       |
+------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_shareable_format<class_RDTextureFormat_method_remove_shareable_format>` **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format **)** |
+------+------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

.. _class_RDTextureFormat_property_array_layers:

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

+-----------+-------------------------+
| *Default* | ``1``                   |
+-----------+-------------------------+
| *Setter*  | set_array_layers(value) |
+-----------+-------------------------+
| *Getter*  | get_array_layers()      |
+-----------+-------------------------+

----

.. _class_RDTextureFormat_property_depth:

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

+-----------+------------------+
| *Default* | ``1``            |
+-----------+------------------+
| *Setter*  | set_depth(value) |
+-----------+------------------+
| *Getter*  | get_depth()      |
+-----------+------------------+

----

.. _class_RDTextureFormat_property_format:

- :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **format**

+-----------+-------------------+
| *Default* | ``8``             |
+-----------+-------------------+
| *Setter*  | set_format(value) |
+-----------+-------------------+
| *Getter*  | get_format()      |
+-----------+-------------------+

----

.. _class_RDTextureFormat_property_height:

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

+-----------+-------------------+
| *Default* | ``1``             |
+-----------+-------------------+
| *Setter*  | set_height(value) |
+-----------+-------------------+
| *Getter*  | get_height()      |
+-----------+-------------------+

----

.. _class_RDTextureFormat_property_mipmaps:

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

+-----------+--------------------+
| *Default* | ``1``              |
+-----------+--------------------+
| *Setter*  | set_mipmaps(value) |
+-----------+--------------------+
| *Getter*  | get_mipmaps()      |
+-----------+--------------------+

----

.. _class_RDTextureFormat_property_samples:

- :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **samples**

+-----------+--------------------+
| *Default* | ``0``              |
+-----------+--------------------+
| *Setter*  | set_samples(value) |
+-----------+--------------------+
| *Getter*  | get_samples()      |
+-----------+--------------------+

----

.. _class_RDTextureFormat_property_texture_type:

- :ref:`TextureType<enum_RenderingDevice_TextureType>` **texture_type**

+-----------+-------------------------+
| *Default* | ``1``                   |
+-----------+-------------------------+
| *Setter*  | set_texture_type(value) |
+-----------+-------------------------+
| *Getter*  | get_texture_type()      |
+-----------+-------------------------+

----

.. _class_RDTextureFormat_property_usage_bits:

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

+-----------+-----------------------+
| *Default* | ``0``                 |
+-----------+-----------------------+
| *Setter*  | set_usage_bits(value) |
+-----------+-----------------------+
| *Getter*  | get_usage_bits()      |
+-----------+-----------------------+

----

.. _class_RDTextureFormat_property_width:

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

+-----------+------------------+
| *Default* | ``1``            |
+-----------+------------------+
| *Setter*  | set_width(value) |
+-----------+------------------+
| *Getter*  | get_width()      |
+-----------+------------------+

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

.. _class_RDTextureFormat_method_add_shareable_format:

- void **add_shareable_format** **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format **)**

----

.. _class_RDTextureFormat_method_remove_shareable_format:

- void **remove_shareable_format** **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format **)**

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