Table of Contents

Class RDTextureFormat

Namespace
Godot
Assembly
GodotSharp.dll

This object is used by RenderingDevice.

public class RDTextureFormat : RefCounted, IDisposable
Inheritance
RDTextureFormat
Implements
Inherited Members

Constructors

RDTextureFormat() 

public RDTextureFormat()

Properties

ArrayLayers

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

public uint ArrayLayers { get; set; }

Property Value

uint

Depth

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

public uint Depth { get; set; }

Property Value

uint

Format

The texture's pixel data format.

public RenderingDevice.DataFormat Format { get; set; }

Property Value

RenderingDevice.DataFormat

Height

The texture's height (in pixels).

public uint Height { get; set; }

Property Value

uint

IsDiscardable

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.

public bool IsDiscardable { get; set; }

Property Value

bool

IsResolveBuffer

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

public bool IsResolveBuffer { get; set; }

Property Value

bool

Mipmaps

The number of mipmaps available in the texture.

public uint Mipmaps { get; set; }

Property Value

uint

Samples

The number of samples used when sampling the texture.

public RenderingDevice.TextureSamples Samples { get; set; }

Property Value

RenderingDevice.TextureSamples

TextureType

The texture type.

public RenderingDevice.TextureType TextureType { get; set; }

Property Value

RenderingDevice.TextureType

UsageBits

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

public RenderingDevice.TextureUsageBits UsageBits { get; set; }

Property Value

RenderingDevice.TextureUsageBits

Width

The texture's width (in pixels).

public uint Width { get; set; }

Property Value

uint

Methods

AddShareableFormat(DataFormat)

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

public void AddShareableFormat(RenderingDevice.DataFormat format)

Parameters

format RenderingDevice.DataFormat

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

RemoveShareableFormat(DataFormat)

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

public void RemoveShareableFormat(RenderingDevice.DataFormat format)

Parameters

format RenderingDevice.DataFormat
Edit this page