Attention: Here be dragons (unstable version)
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Redot.
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, Redot 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(layer_index: int) 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(layer: int) 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(layer_index: int) virtual const 🔗
Called when the data for a layer in the TextureLayered is queried.
int _get_layered_type() virtual const 🔗
Called when the layers' type in the TextureLayered is queried.
int _get_layers() virtual const 🔗
Called when the number of layers in the TextureLayered is queried.
int _get_width() virtual const 🔗
Called when the TextureLayered's width queried.
bool _has_mipmaps() virtual const 🔗
Called when the presence of mipmaps in the TextureLayered is queried.
Returns the current format being used by this texture. See Format for details.
Returns the height of the texture in pixels. Height is typically represented by the Y axis.
Image get_layer_data(layer: int) const 🔗
Returns an Image resource with the data from specified layer.
LayeredType get_layered_type() const 🔗
Returns the TextureLayered's type. The type determines how the data is accessed, with cubemaps having special types.
Returns the number of referenced Images.
Returns the width of the texture in pixels. Width is typically represented by the X axis.
Returns true if the layers have generated mipmaps.