RDTextureFormat

package
v0.0.0-...-20ed0ac Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 19, 2025 License: MIT Imports: 24 Imported by: 0

Documentation

Overview

This object is used by RenderingDevice.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsRDTextureFormat() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRDTextureFormat

func (self *Extension[T]) AsRDTextureFormat() Instance

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.RDTextureFormat

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AddShareableFormat

func (self Instance) AddShareableFormat(format Rendering.DataFormat)

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

func (Instance) ArrayLayers

func (self Instance) ArrayLayers() int

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

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRDTextureFormat

func (self Instance) AsRDTextureFormat() Instance

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) Depth

func (self Instance) Depth() int

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

func (Instance) Format

func (self Instance) Format() Rendering.DataFormat

The texture's pixel data format.

func (Instance) Height

func (self Instance) Height() int

The texture's height (in pixels).

func (Instance) ID

func (self Instance) ID() ID

func (Instance) IsDiscardable

func (self Instance) IsDiscardable() 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.

func (Instance) IsResolveBuffer

func (self Instance) IsResolveBuffer() bool

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

func (Instance) Mipmaps

func (self Instance) Mipmaps() int

The number of mipmaps available in the texture.

func (Instance) RemoveShareableFormat

func (self Instance) RemoveShareableFormat(format Rendering.DataFormat)

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

func (Instance) Samples

func (self Instance) Samples() Rendering.TextureSamples

The number of samples used when sampling the texture.

func (Instance) SetArrayLayers

func (self Instance) SetArrayLayers(value int)

SetArrayLayers sets the property returned by [GetArrayLayers].

func (Instance) SetDepth

func (self Instance) SetDepth(value int)

SetDepth sets the property returned by [GetDepth].

func (Instance) SetFormat

func (self Instance) SetFormat(value Rendering.DataFormat)

SetFormat sets the property returned by [GetFormat].

func (Instance) SetHeight

func (self Instance) SetHeight(value int)

SetHeight sets the property returned by [GetHeight].

func (Instance) SetIsDiscardable

func (self Instance) SetIsDiscardable(value bool)

SetIsDiscardable sets the property returned by [GetIsDiscardable].

func (Instance) SetIsResolveBuffer

func (self Instance) SetIsResolveBuffer(value bool)

SetIsResolveBuffer sets the property returned by [GetIsResolveBuffer].

func (Instance) SetMipmaps

func (self Instance) SetMipmaps(value int)

SetMipmaps sets the property returned by [GetMipmaps].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetSamples

func (self Instance) SetSamples(value Rendering.TextureSamples)

SetSamples sets the property returned by [GetSamples].

func (Instance) SetTextureType

func (self Instance) SetTextureType(value Rendering.TextureType)

SetTextureType sets the property returned by [GetTextureType].

func (Instance) SetUsageBits

func (self Instance) SetUsageBits(value Rendering.TextureUsageBits)

SetUsageBits sets the property returned by [GetUsageBits].

func (Instance) SetWidth

func (self Instance) SetWidth(value int)

SetWidth sets the property returned by [GetWidth].

func (Instance) TextureType

func (self Instance) TextureType() Rendering.TextureType

The texture type.

func (Instance) UsageBits

func (self Instance) UsageBits() Rendering.TextureUsageBits

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

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

func (Instance) Width

func (self Instance) Width() int

The texture's width (in pixels).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL