Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Gradient¶
Inherits: Resource < RefCounted < 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¶
|
||
|
||
|
Methods¶
void |
|
get_offset ( int point ) |
|
get_point_count ( ) const |
|
void |
remove_point ( int point ) |
void |
reverse ( ) |
void |
|
void |
set_offset ( int point, float offset ) |
Enumerations¶
enum InterpolationMode:
InterpolationMode GRADIENT_INTERPOLATE_LINEAR = 0
Linear interpolation.
InterpolationMode 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.
InterpolationMode GRADIENT_INTERPOLATE_CUBIC = 2
Cubic interpolation.
Property Descriptions¶
PackedColorArray colors = PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)
void set_colors ( PackedColorArray value )
PackedColorArray get_colors ( )
Gradient's colors returned as a PackedColorArray.
InterpolationMode interpolation_mode = 0
void set_interpolation_mode ( InterpolationMode value )
InterpolationMode get_interpolation_mode ( )
Defines how the colors between points of the gradient are interpolated. See InterpolationMode for available modes.
PackedFloat32Array offsets = PackedFloat32Array(0, 1)
void set_offsets ( PackedFloat32Array value )
PackedFloat32Array get_offsets ( )
Gradient's offsets returned as a PackedFloat32Array.
Method Descriptions¶
void add_point ( float offset, Color color )
Adds the specified color to the end of the gradient, with the specified offset.
Returns the color of the gradient color at index point
.
float get_offset ( int point )
Returns the offset of the gradient color at index point
.
int get_point_count ( ) const
Returns the number of colors in the gradient.
void remove_point ( int point )
Removes the color at the index point
.
void reverse ( )
Reverses/mirrors the gradient.
Returns the interpolated color specified by offset
.
void set_color ( int point, Color color )
Sets the color of the gradient color at index point
.
void set_offset ( int point, float offset )
Sets the offset for the gradient color at index point
.