Gradient

package

v0.0.0-...-5eaf078 Latest Latest Go to latest Published: Sep 4, 2025 License: MIT Imports: 25 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/quaadgras/graphics.gd

Links

Open Source Insights

Documentation ¶

Overview ¶

Package Gradient provides methods for working with Gradient object instances.

Index ¶

type Advanced
type Any
type ColorSpace
type Extension
type ID
- func (id ID) Instance() (Instance, bool)
type Instance
- func New() Instance
type InterpolationMode

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
	AsGradient() Instance
}

type ColorSpace ¶

type ColorSpace int //gd:Gradient.ColorSpace

const (
	/*sRGB color space.*/
	GradientColorSpaceSrgb ColorSpace = 0
	/*Linear sRGB color space.*/
	GradientColorSpaceLinearSrgb ColorSpace = 1
	/*[url=https://bottosson.github.io/posts/oklab/]Oklab[/url] color space. This color space provides a smooth and uniform-looking transition between colors.*/
	GradientColorSpaceOklab ColorSpace = 2
)

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]) AsGradient ¶

func (self *Extension[T]) AsGradient() 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

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

This resource describes a color transition by defining a set of colored points and how to interpolate between them. See also [Curve] which supports more complex easing methods, but does not support colors.

var Nil Instance

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

func New ¶

func New() Instance

func (Instance) AddPoint ¶

func (self Instance) AddPoint(offset Float.X, color Color.RGBA)

Adds the specified color to the gradient, with the specified offset.

func (Instance) AsGradient ¶

func (self Instance) AsGradient() 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) Colors ¶

func (self Instance) Colors() []Color.RGBA

func (Instance) GetColor ¶

func (self Instance) GetColor(point int) Color.RGBA

Returns the color of the gradient color at index [param point].

func (Instance) GetOffset ¶

func (self Instance) GetOffset(point int) Float.X

Returns the offset of the gradient color at index [param point].

func (Instance) GetPointCount ¶

func (self Instance) GetPointCount() int

Returns the number of colors in the gradient.

func (Instance) ID ¶

func (self Instance) ID() ID

func (Instance) InterpolationColorSpace ¶

func (self Instance) InterpolationColorSpace() ColorSpace

func (Instance) InterpolationMode ¶

func (self Instance) InterpolationMode() InterpolationMode

func (Instance) Offsets ¶

func (self Instance) Offsets() []float32

func (Instance) RemovePoint ¶

func (self Instance) RemovePoint(point int)

Removes the color at index [param point].

func (Instance) Reverse ¶

func (self Instance) Reverse()

Reverses/mirrors the gradient. [b]Note:[/b] This method mirrors all points around the middle of the gradient, which may produce unexpected results when [member interpolation_mode] is set to [constant GRADIENT_INTERPOLATE_CONSTANT].

func (Instance) Sample ¶

func (self Instance) Sample(offset Float.X) Color.RGBA

Returns the interpolated color specified by [param offset].

func (Instance) SetColor ¶

func (self Instance) SetColor(point int, color Color.RGBA)

Sets the color of the gradient color at index [param point].

func (Instance) SetColors ¶

func (self Instance) SetColors(value []Color.RGBA)

func (Instance) SetInterpolationColorSpace ¶

func (self Instance) SetInterpolationColorSpace(value ColorSpace)

func (Instance) SetInterpolationMode ¶

func (self Instance) SetInterpolationMode(value InterpolationMode)

func (*Instance) SetObject ¶

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

func (Instance) SetOffset ¶

func (self Instance) SetOffset(point int, offset Float.X)

Sets the offset for the gradient color at index [param point].

func (Instance) SetOffsets ¶

func (self Instance) SetOffsets(value []float32)

func (*Instance) UnsafePointer ¶

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual ¶

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

type InterpolationMode ¶

type InterpolationMode int //gd:Gradient.InterpolationMode

const (
	/*Linear interpolation.*/
	GradientInterpolateLinear InterpolationMode = 0
	/*Constant interpolation, color changes abruptly at each point and stays uniform between. This might cause visible aliasing when used for a gradient texture in some cases.*/
	GradientInterpolateConstant InterpolationMode = 1
	/*Cubic interpolation.*/
	GradientInterpolateCubic InterpolationMode = 2
)

Source Files ¶

View all Source files

class.go

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