Index · Object → RefCounted → Resource → Texture → TextureLayered

TextureLayered

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

Inherited by (4): CompressedTextureLayeredImageTextureLayeredPlaceholderTextureLayeredTextureLayeredRD
Class 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).

Properties

Inherited from Resource (4)

Methods

func _get_format() -> Image.Format

Called when the TextureLayered's format is queried.

func _get_height() -> int

Called when the TextureLayered's height is queried.

func _get_layer_data(layer_index: int) -> Image

Called when the data for a layer in the TextureLayered is queried.

func _get_layered_type() -> int

Called when the layers' type in the TextureLayered is queried.

func _get_layers() -> int

Called when the number of layers in the TextureLayered is queried.

func _get_width() -> int

Called when the TextureLayered's width queried.

func _has_mipmaps() -> bool

Called when the presence of mipmaps in the TextureLayered is queried.

func get_format() -> Image.Format

Returns the current format being used by this texture.

func get_height() -> int

Returns the height of the texture in pixels. Height is typically represented by the Y axis.

func get_layer_data(layer: int) -> Image

Returns an Image resource with the data from specified layer.

func get_layered_type() -> TextureLayered.LayeredType

Returns the TextureLayered's type. The type determines how the data is accessed, with cubemaps having special types.

func get_layers() -> int

Returns the number of referenced Images.

func get_width() -> int

Returns the width of the texture in pixels. Width is typically represented by the X axis.

func has_mipmaps() -> bool

Returns true if the layers have generated mipmaps.

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

enum LayeredType
LAYERED_TYPE_2D_ARRAY = 0

Texture is a generic Texture2DArray.

LAYERED_TYPE_CUBEMAP = 1

Texture is a Cubemap, with each side in its own layer (6 in total).

LAYERED_TYPE_CUBEMAP_ARRAY = 2

Texture is a CubemapArray, with each cubemap being made of 6 layers.