Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
TextureLayered¶
Inherits: Texture < Resource < RefCounted < Object
Inherited By: CompressedTextureLayered, ImageTextureLayered, PlaceholderTextureLayered, TextureLayeredRD
Base class for texture types which contain the data of multiple Images. Each image is of the same size and format.
Description¶
Base class for ImageTextureLayered and CompressedTextureLayered. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also Texture3D.
Data is set on a per-layer basis. For Texture2DArrays, the layer specifies the array layer.
All images need to have the same width, height and number of mipmap levels.
A TextureLayered can be loaded with ResourceLoader.load.
Internally, Godot maps these files to their respective counterparts in the target rendering driver (Vulkan, OpenGL3).
Methods¶
_get_format ( ) virtual const |
|
_get_height ( ) virtual const |
|
_get_layer_data ( int layer_index ) virtual const |
|
_get_layered_type ( ) virtual const |
|
_get_layers ( ) virtual const |
|
_get_width ( ) virtual const |
|
_has_mipmaps ( ) virtual const |
|
get_format ( ) const |
|
get_height ( ) const |
|
get_layer_data ( int layer ) const |
|
get_layered_type ( ) const |
|
get_layers ( ) const |
|
get_width ( ) const |
|
has_mipmaps ( ) const |
Enumerations¶
enum LayeredType:
LayeredType LAYERED_TYPE_2D_ARRAY = 0
Texture is a generic Texture2DArray.
LayeredType LAYERED_TYPE_CUBEMAP = 1
Texture is a Cubemap, with each side in its own layer (6 in total).
LayeredType LAYERED_TYPE_CUBEMAP_ARRAY = 2
Texture is a CubemapArray, with each cubemap being made of 6 layers.
Method Descriptions¶
Format _get_format ( ) virtual const
Called when the TextureLayered's format is queried.
int _get_height ( ) virtual const
Called when the TextureLayered's height is queried.
Image _get_layer_data ( int layer_index ) virtual const
Called when the data for a layer in the TextureLayered is queried.