Up to date

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

RDTextureFormat

Inherits: RefCounted < Object

Texture format (used by RenderingDevice).

Description

This object is used by RenderingDevice.

Properties

int	array_layers	1
int	depth	1
DataFormat	format	8
int	height	1
int	mipmaps	1
TextureSamples	samples	0
TextureType	texture_type	1
BitField<TextureUsageBits>	usage_bits	0
int	width	1

Methods

void	add_shareable_format ( DataFormat format )
void	remove_shareable_format ( DataFormat format )

---

Property Descriptions

int array_layers = 1

• void set_array_layers ( int value )

• int get_array_layers ( )

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

---

int depth = 1

• void set_depth ( int value )

• int get_depth ( )

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

---

DataFormat format = 8

• void set_format ( DataFormat value )

• DataFormat get_format ( )

The texture's pixel data format.

---

int height = 1

• void set_height ( int value )

• int get_height ( )

The texture's height (in pixels).

---

int mipmaps = 1

• void set_mipmaps ( int value )

• int get_mipmaps ( )

The number of mipmaps available in the texture.

---

TextureSamples samples = 0

• void set_samples ( TextureSamples value )

• TextureSamples get_samples ( )

The number of samples used when sampling the texture.

---

TextureType texture_type = 1

• void set_texture_type ( TextureType value )

• TextureType get_texture_type ( )

The texture type.

---

BitField<TextureUsageBits> usage_bits = 0

• void set_usage_bits ( BitField<TextureUsageBits> value )

• BitField<TextureUsageBits> get_usage_bits ( )

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

---

int width = 1

• void set_width ( int value )

• int get_width ( )

The texture's width (in pixels).

---

Method Descriptions

void add_shareable_format ( DataFormat format )

There is currently no description for this method. Please help us by contributing one!

---

void remove_shareable_format ( DataFormat format )

There is currently no description for this method. Please help us by contributing one!