GradientTexture2D

package
v0.0.0-...-0d6c339 Latest Latest
Warning

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

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 27 Imported by: 0

Documentation

Overview

A 2D texture that obtains colors from a graphics.gd/classdb/Gradient to fill the texture data. This texture is able to transform a color transition into different patterns such as a linear or a radial gradient. The texture is filled by interpolating colors starting from Instance.FillFrom to Instance.FillTo offsets by default, but the gradient fill can be repeated to cover the entire texture.

The gradient is sampled individually for each pixel so it does not necessarily represent an exact copy of the gradient (see [Instance.Width] and [Instance.Height]). See also graphics.gd/classdb/GradientTexture1D, graphics.gd/classdb/CurveTexture and graphics.gd/classdb/CurveXYZTexture.

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
	AsGradientTexture2D() 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]) AsGradientTexture2D

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

func (*Extension[T]) AsObject

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

func (*Extension[T]) AsRefCounted

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

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

func (*Extension[T]) AsTexture

func (self *Extension[T]) AsTexture() Texture.Instance

func (*Extension[T]) AsTexture2D

func (self *Extension[T]) AsTexture2D() Texture2D.Instance

type Fill

type Fill int //gd:GradientTexture2D.Fill
const (
	// The colors are linearly interpolated in a straight line.
	FillLinear Fill = 0
	// The colors are linearly interpolated in a circular pattern.
	FillRadial Fill = 1
	// The colors are linearly interpolated in a square pattern.
	FillSquare Fill = 2
)

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

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) AsGradientTexture2D

func (self Instance) AsGradientTexture2D() Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

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

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AsTexture

func (self Instance) AsTexture() Texture.Instance

func (Instance) AsTexture2D

func (self Instance) AsTexture2D() Texture2D.Instance

func (Instance) Fill

func (self Instance) Fill() Fill

func (Instance) FillFrom

func (self Instance) FillFrom() Vector2.XY

func (Instance) FillTo

func (self Instance) FillTo() Vector2.XY

func (Instance) Gradient

func (self Instance) Gradient() Gradient.Instance

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Repeat

func (self Instance) Repeat() Repeat

func (Instance) SetFill

func (self Instance) SetFill(value Fill)

func (Instance) SetFillFrom

func (self Instance) SetFillFrom(value Vector2.XY)

func (Instance) SetFillTo

func (self Instance) SetFillTo(value Vector2.XY)

func (Instance) SetGradient

func (self Instance) SetGradient(value Gradient.Instance)

func (Instance) SetHeight

func (self Instance) SetHeight(value int)

func (*Instance) SetObject

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

func (Instance) SetRepeat

func (self Instance) SetRepeat(value Repeat)

func (Instance) SetUseHdr

func (self Instance) SetUseHdr(value bool)

func (Instance) SetWidth

func (self Instance) SetWidth(value int)

func (Instance) UseHdr

func (self Instance) UseHdr() bool

func (Instance) Virtual

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

type Repeat

type Repeat int //gd:GradientTexture2D.Repeat
const (
	// The gradient fill is restricted to the range defined by [Instance.FillFrom] to [Instance.FillTo] offsets.
	RepeatNone Repeat = 0
	// The texture is filled starting from [Instance.FillFrom] to [Instance.FillTo] offsets, repeating the same pattern in both directions.
	RepeatDefault Repeat = 1
	// The texture is filled starting from [Instance.FillFrom] to [Instance.FillTo] offsets, mirroring the pattern in both directions.
	RepeatMirror Repeat = 2
)

Jump to

Keyboard shortcuts

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