Index · Object → RefCounted → RDTextureFormat

RDTextureFormat

Texture format (used by RenderingDevice).

Class Description

This object is used by RenderingDevice.

Properties

var array_layers: int = 1

The number of layers in the texture. Only relevant for 2D texture arrays.

var depth: int = 1

The texture's depth (in pixels). This is always 1 for 2D textures.

var format: RenderingDevice.DataFormat = 8

The texture's pixel data format.

var height: int = 1

The texture's height (in pixels).

var is_discardable: bool = false

If a texture is discardable, its contents do not need to be preserved between frames. This flag is only relevant when the texture is used as target in a draw list.

This information is used by RenderingDevice to figure out if a texture's contents can be discarded, eliminating unnecessary writes to memory and boosting performance.

var is_resolve_buffer: bool = false

The texture will be used as the destination of a resolve operation.

var mipmaps: int = 1

The number of mipmaps available in the texture.

var samples: RenderingDevice.TextureSamples = 0

The number of samples used when sampling the texture.

var texture_type: RenderingDevice.TextureType = 1

The texture type.

var usage_bits: RenderingDevice.TextureUsageBits = 0

The texture's usage bits, which determine what can be done using the texture.

var width: int = 1

The texture's width (in pixels).

Methods

func add_shareable_format(format: RenderingDevice.DataFormat) -> void

Adds format as a valid format for the corresponding RDTextureView's RDTextureView.format_override property. If any format is added as shareable, then the main format must also be added.

func remove_shareable_format(format: RenderingDevice.DataFormat) -> void

Removes format from the list of valid formats that the corresponding RDTextureView's RDTextureView.format_override property can be set to.

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 Object (2)