Up to date

This page is up to date for Godot 4.1. If you still find outdated information, please open an issue.

ImageTextureLayered

Inherits: TextureLayered < Texture < Resource < RefCounted < Object

Inherited By: Cubemap, CubemapArray, Texture2DArray

Base class for texture types which contain the data of multiple ImageTextures. Each image is of the same size and format.

Description

Base class for Texture2DArray, Cubemap and CubemapArray. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also Texture3D.

Methods

Error

create_from_images ( Image[] images )

void

update_layer ( Image image, int layer )


Method Descriptions

Error create_from_images ( Image[] images )

Creates an ImageTextureLayered from an array of Images. See Image.create for the expected data format. The first image decides the width, height, image format and mipmapping setting. The other images must have the same width, height, image format and mipmapping setting.

Each Image represents one layer.


void update_layer ( Image image, int layer )

Replaces the existing Image data at the given layer with this new image.

The given Image must have the same width, height, image format and mipmapping setting (a bool value) as the rest of the referenced images.

If the image format is unsupported, it will be decompressed and converted to a similar and supported Format.

The update is immediate: it's synchronized with drawing.