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

classref: Sync with latest 4.0-dev

Browse Source
This commit is contained in:
Rémi Verschelde
2021-10-05 16:09:21 +02:00
parent 6952796767
commit f6f6c1bf19
958 changed files with 113054 additions and 52009 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
classes/class_texturelayered.rst
View File

@@ -9,9 +9,9 @@
TextureLayered
==============
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`Cubemap<class_Cubemap>`, :ref:`CubemapArray<class_CubemapArray>`, :ref:`Texture2DArray<class_Texture2DArray>`
**Inherited By:** :ref:`ImageTextureLayered<class_ImageTextureLayered>`, :ref:`StreamTextureLayered<class_StreamTextureLayered>`
Base class for 3D texture types.
@@ -23,34 +23,47 @@ Base class for :ref:`Texture2DArray<class_Texture2DArray>`, :ref:`Cubemap<class_
Methods
-------
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`create_from_images<class_TextureLayered_method_create_from_images>` **(** :ref:`Array<class_Array>` images **)** |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :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_layers<class_TextureLayered_method_get_layers>` **(** **)** const |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_TextureLayered_method_get_width>` **(** **)** const |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_layer<class_TextureLayered_method_update_layer>` **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)** |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :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_create_from_images:
- :ref:`Error<enum_@GlobalScope_Error>` **create_from_images** **(** :ref:`Array<class_Array>` images **)**
----
.. _class_TextureLayered_method_get_format:
- :ref:`Format<enum_Image_Format>` **get_format** **(** **)** const
- :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.
@@ -58,7 +71,7 @@ Returns the current format being used by this texture. See :ref:`Format<enum_Ima
.. _class_TextureLayered_method_get_height:
- :ref:`int<class_int>` **get_height** **(** **)** const
- :ref:`int<class_int>` **get_height** **(** **)** |const|
Returns the height of the texture. Height is typically represented by the Y-axis.
@@ -66,27 +79,39 @@ 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
- :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
- :ref:`int<class_int>` **get_layers** **(** **)** |const|
----
.. _class_TextureLayered_method_get_width:
- :ref:`int<class_int>` **get_width** **(** **)** const
- :ref:`int<class_int>` **get_width** **(** **)** |const|
Returns the width of the texture. Width is typically represented by the X-axis.
----
.. _class_TextureLayered_method_update_layer:
.. _class_TextureLayered_method_has_mipmaps:
- void **update_layer** **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)**
- :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.)`