Gradient¶

Inherits: Resource < Reference < Object

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

Description¶

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 gradient will interpolate from color 1 to color 2 and from color 2 to color 3. The gradient will initially have 2 colors (black and white), one (black) at gradient lower offset 0 and the other (white) at the gradient higher offset 1.

See also Curve which supports more complex easing methods, but does not support colors.

Properties¶

PoolColorArray	colors	`PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )`
InterpolationMode	interpolation_mode	`0`
PoolRealArray	offsets	`PoolRealArray( 0, 1 )`

Methods¶

void	add_point ( float offset, Color color )
Color	get_color ( int point )
float	get_offset ( int point )
int	get_point_count ( ) const
Color	interpolate ( float offset )
void	remove_point ( int point )
void	set_color ( int point, Color color )
void	set_offset ( int point, float offset )

Enumerations¶

enum InterpolationMode:

GRADIENT_INTERPOLATE_LINEAR = 0 --- Linear interpolation.
GRADIENT_INTERPOLATE_CONSTANT = 1 --- 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.
GRADIENT_INTERPOLATE_CUBIC = 2 --- Cubic interpolation.

Property Descriptions¶

PoolColorArray colors

Default	`PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )`
Setter	set_colors(value)
Getter	get_colors()

Gradient's colors returned as a PoolColorArray.

InterpolationMode interpolation_mode

Default	`0`
Setter	set_interpolation_mode(value)
Getter	get_interpolation_mode()

Defines how the colors between points of the gradient are interpolated. See InterpolationMode for available modes.

PoolRealArray offsets

Default	`PoolRealArray( 0, 1 )`
Setter	set_offsets(value)
Getter	get_offsets()

Gradient's offsets returned as a PoolRealArray.

Method Descriptions¶

void add_point ( float offset, Color color )

Adds the specified color to the end of the ramp, with the specified offset.

Color get_color ( int point )

Returns the color of the ramp color at index point.

float get_offset ( int point )

Returns the offset of the ramp color at index point.

int get_point_count ( ) const

Returns the number of colors in the ramp.

Color interpolate ( float offset )

Returns the interpolated color specified by offset.

void remove_point ( int point )

Removes the color at the index point.

void set_color ( int point, Color color )

Sets the color of the ramp color at index point.

void set_offset ( int point, float offset )

Sets the offset for the ramp color at index point.