Struct Gradient

A color interpolator resource which can be used to generate colors between user-defined color points.

struct Gradient ;

Given a set of colors, this resource will interpolate them in order. This means that if you have color 1, color 2 and color 3, the ramp will interpolate from color 1 to color 2 and from color 2 to color 3. The ramp will initially have 2 colors (black and white), one (black) at ramp lower offset 0 and the other (white) at the ramp higher offset 1.

Properties

NameTypeDescription
colors[get, set] PoolArray!(godot.core.color.Color)Gradient's colors returned as a PoolColorArray.
offsets[get, set] PoolArray!(float)Gradient's offsets returned as a PoolRealArray.

Methods

NameDescription
addPoint Adds the specified color to the end of the ramp, with the specified offset.
getColor Returns the color of the ramp color at index point.
getColors
getOffset Returns the offset of the ramp color at index point.
getOffsets
getPointCount Returns the number of colors in the ramp.
interpolate Returns the interpolated color specified by offset.
removePoint Removes the color at the index offset.
setColor Sets the color of the ramp color at index point.
setColors
setOffset Sets the offset for the ramp color at index point.
setOffsets