Documentation
¶
Overview ¶
A 2D texture that obtains colors from a 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 FillFrom to 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 Width and Height). See also GradientTexture1D, CurveTexture and CurveXYZTexture.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsGradientTexture2D() Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
- func (self *Extension[T]) AsResource() Resource.Instance
- func (self *Extension[T]) AsTexture() Texture.Instance
- func (self *Extension[T]) AsTexture2D() Texture2D.Instance
- type Fill
- type ID
- type Instance
- func (self Instance) AsGradientTexture2D() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsTexture() Texture.Instance
- func (self Instance) AsTexture2D() Texture2D.Instance
- func (self Instance) Fill() Fill
- func (self Instance) FillFrom() Vector2.XY
- func (self Instance) FillTo() Vector2.XY
- func (self Instance) Gradient() Gradient.Instance
- func (self Instance) ID() ID
- func (self Instance) Repeat() Repeat
- func (self Instance) SetFill(value Fill)
- func (self Instance) SetFillFrom(value Vector2.XY)
- func (self Instance) SetFillTo(value Vector2.XY)
- func (self Instance) SetGradient(value Gradient.Instance)
- func (self Instance) SetHeight(value int)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetRepeat(value Repeat)
- func (self Instance) SetUseHdr(value bool)
- func (self Instance) SetWidth(value int)
- func (self Instance) UseHdr() bool
- func (self Instance) Virtual(name string) reflect.Value
- type Repeat
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 Extension ¶
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 (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
func (*Extension[T]) AsTexture2D ¶
type 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.
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 (Instance) AsGradientTexture2D ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsTexture2D ¶
func (Instance) SetFillFrom ¶
SetFillFrom sets the property returned by [GetFillFrom].
func (Instance) SetGradient ¶
SetGradient sets the property returned by [GetGradient].
func (Instance) SetHeight ¶
The number of vertical color samples that will be obtained from the Gradient, which also represents the texture's height.
func (Instance) SetWidth ¶
The number of horizontal color samples that will be obtained from the Gradient, which also represents the texture's width.
func (Instance) UseHdr ¶
If true, the generated texture will support high dynamic range ([Image.FormatRgbaf] format). This allows for glow effects to work if Environment.GlowEnabled is true. If false, the generated texture will use low dynamic range; overbright colors will be clamped ([Image.FormatRgba8] format).
type Repeat ¶
type Repeat int //gd:GradientTexture2D.Repeat
const ( // The gradient fill is restricted to the range defined by [FillFrom] to [FillTo] offsets. // // [FillFrom]: https://pkg.go.dev/graphics.gd/classdb/#Instance.FillFrom // [FillTo]: https://pkg.go.dev/graphics.gd/classdb/#Instance.FillTo RepeatNone Repeat = 0 // The texture is filled starting from [FillFrom] to [FillTo] offsets, repeating the same pattern in both directions. // // [FillFrom]: https://pkg.go.dev/graphics.gd/classdb/#Instance.FillFrom // [FillTo]: https://pkg.go.dev/graphics.gd/classdb/#Instance.FillTo RepeatDefault Repeat = 1 // The texture is filled starting from [FillFrom] to [FillTo] offsets, mirroring the pattern in both directions. // // [FillFrom]: https://pkg.go.dev/graphics.gd/classdb/#Instance.FillFrom // [FillTo]: https://pkg.go.dev/graphics.gd/classdb/#Instance.FillTo RepeatMirror Repeat = 2 )
Source Files