godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
23078c194bc259a1aa8ee88aec56caca692ef501
godot-docs/classes/class_texturelayered.rst
Rémi Verschelde 23078c194b classref: Update generated warning header 
Applying changes from https://github.com/godotengine/godot/pull/63495.
2022-07-27 13:59:06 +02:00

175 lines
9.7 KiB
ReStructuredText
Raw Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureLayered.xml.
.. _class_TextureLayered:
TextureLayered
==============
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`CompressedTextureLayered<class_CompressedTextureLayered>`, :ref:`ImageTextureLayered<class_ImageTextureLayered>`, :ref:`PlaceholderTextureLayered<class_PlaceholderTextureLayered>`
Base class for 3D texture types.
Description
-----------
Base class for :ref:`Texture2DArray<class_Texture2DArray>`, :ref:`Cubemap<class_Cubemap>` and :ref:`CubemapArray<class_CubemapArray>`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. Data is set on a per-layer basis. For :ref:`Texture2DArray<class_Texture2DArray>`\ s, the layer specifies the array layer.
Methods
-------
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Format<enum_Image_Format>` | :ref:`_get_format<class_TextureLayered_method__get_format>` **(** **)** |virtual| |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`_get_height<class_TextureLayered_method__get_height>` **(** **)** |virtual| |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_Image>` | :ref:`_get_layer_data<class_TextureLayered_method__get_layer_data>` **(** :ref:`int<class_int>` layer_index **)** |virtual| |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`_get_layered_type<class_TextureLayered_method__get_layered_type>` **(** **)** |virtual| |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`_get_layers<class_TextureLayered_method__get_layers>` **(** **)** |virtual| |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`_get_width<class_TextureLayered_method__get_width>` **(** **)** |virtual| |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_has_mipmaps<class_TextureLayered_method__has_mipmaps>` **(** **)** |virtual| |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:`LayeredType<enum_TextureLayered_LayeredType>` | :ref:`get_layered_type<class_TextureLayered_method_get_layered_type>` **(** **)** |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_layers<class_TextureLayered_method_get_layers>` **(** **)** |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_TextureLayered_method_get_width>` **(** **)** |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_mipmaps<class_TextureLayered_method_has_mipmaps>` **(** **)** |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
.. _enum_TextureLayered_LayeredType:
.. _class_TextureLayered_constant_LAYERED_TYPE_2D_ARRAY:
.. _class_TextureLayered_constant_LAYERED_TYPE_CUBEMAP:
.. _class_TextureLayered_constant_LAYERED_TYPE_CUBEMAP_ARRAY:
enum **LayeredType**:
- **LAYERED_TYPE_2D_ARRAY** = **0**
- **LAYERED_TYPE_CUBEMAP** = **1**
- **LAYERED_TYPE_CUBEMAP_ARRAY** = **2**
Method Descriptions
-------------------
.. _class_TextureLayered_method__get_format:
- :ref:`Format<enum_Image_Format>` **_get_format** **(** **)** |virtual| |const|
----
.. _class_TextureLayered_method__get_height:
- :ref:`int<class_int>` **_get_height** **(** **)** |virtual| |const|
----
.. _class_TextureLayered_method__get_layer_data:
- :ref:`Image<class_Image>` **_get_layer_data** **(** :ref:`int<class_int>` layer_index **)** |virtual| |const|
----
.. _class_TextureLayered_method__get_layered_type:
- :ref:`int<class_int>` **_get_layered_type** **(** **)** |virtual| |const|
----
.. _class_TextureLayered_method__get_layers:
- :ref:`int<class_int>` **_get_layers** **(** **)** |virtual| |const|
----
.. _class_TextureLayered_method__get_width:
- :ref:`int<class_int>` **_get_width** **(** **)** |virtual| |const|
----
.. _class_TextureLayered_method__has_mipmaps:
- :ref:`bool<class_bool>` **_has_mipmaps** **(** **)** |virtual| |const|
----
.. _class_TextureLayered_method_get_format:
- :ref:`Format<enum_Image_Format>` **get_format** **(** **)** |const|
Returns the current format being used by this texture. See :ref:`Format<enum_Image_Format>` for details.
----
.. _class_TextureLayered_method_get_height:
- :ref:`int<class_int>` **get_height** **(** **)** |const|
Returns the height of the texture. Height is typically represented by the Y-axis.
----
.. _class_TextureLayered_method_get_layer_data:
- :ref:`Image<class_Image>` **get_layer_data** **(** :ref:`int<class_int>` layer **)** |const|
Returns an :ref:`Image<class_Image>` resource with the data from specified ``layer``.
----
.. _class_TextureLayered_method_get_layered_type:
- :ref:`LayeredType<enum_TextureLayered_LayeredType>` **get_layered_type** **(** **)** |const|
----
.. _class_TextureLayered_method_get_layers:
- :ref:`int<class_int>` **get_layers** **(** **)** |const|
----
.. _class_TextureLayered_method_get_width:
- :ref:`int<class_int>` **get_width** **(** **)** |const|
Returns the width of the texture. Width is typically represented by the X-axis.
----
.. _class_TextureLayered_method_has_mipmaps:
- :ref:`bool<class_bool>` **has_mipmaps** **(** **)** |const|
.. |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.)`
Reference in New Issue View Git Blame Copy Permalink