RDTextureFormat
Inherits: RefCounted < Object
Texture format (used by RenderingDevice).
Description
This object is used by RenderingDevice.
Properties
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
BitField[TextureUsageBits] |
|
|
|
Methods
void |
add_shareable_format(format: DataFormat) |
void |
remove_shareable_format(format: DataFormat) |
Property Descriptions
The number of layers in the texture. Only relevant for 2D texture arrays.
The texture's depth (in pixels). This is always 1
for 2D textures.
DataFormat format = 8
🔗
void set_format(value: DataFormat)
DataFormat get_format()
The texture's pixel data format.
The texture's height (in pixels).
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 = false
🔗
The texture will be used as the destination of a resolve operation.
The number of mipmaps available in the texture.
TextureSamples samples = 0
🔗
void set_samples(value: TextureSamples)
TextureSamples get_samples()
The number of samples used when sampling the texture.
TextureType texture_type = 1
🔗
void set_texture_type(value: TextureType)
TextureType get_texture_type()
The texture type.
BitField[TextureUsageBits] usage_bits = 0
🔗
void set_usage_bits(value: BitField[TextureUsageBits])
BitField[TextureUsageBits] get_usage_bits()
The texture's usage bits, which determine what can be done using the texture.
The texture's width (in pixels).
Method Descriptions
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.
Removes format
from the list of valid formats that the corresponding RDTextureView's RDTextureView.format_override property can be set to.