RDTextureFormat | Godot Docs 4.4

class-description

NEWS

COMMUNITY

STORE

TUTORIALS

LOGOUT

LOGOUT

Object

RDTextureFormat

Texture format (used by RenderingDevice).

This object is used by RenderingDevice.

int

array_layers

()

:int

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

int

depth

()

:int

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

DataFormat

format

()

:DataFormat

The texture's pixel data format.

int

height

()

:int

The texture's height (in pixels).

bool

is_discardable

()

:bool

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.

bool

is_resolve_buffer

()

:bool

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

int

mipmaps

()

:int

The number of mipmaps available in the texture.

TextureSamples

samples

()

:TextureSamples

The number of samples used when sampling the texture.

TextureType

texture_type

()

:TextureType

The texture type.

BitField

usage_bits

()

:BitField

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

int

width

()

:int

The texture's width (in pixels).

void

add_shareable_format

(

DataFormat

format

: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.

void

remove_shareable_format

(

DataFormat

format

:DataFormat

)

:void

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