Welcome to the Godot Reference Fork and the Godot Proposals Fork alternatives. Why?


0 0 vote
Article Rating

Inherits: Resource < Reference < Object

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


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.


PoolColorArraycolorsPoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )
PoolRealArrayoffsetsPoolRealArray( 0, 1 )


voidadd_point ( float offset, Color color )
Colorget_color ( int point ) const
floatget_offset ( int point ) const
intget_point_count ( ) const
Colorinterpolate ( float offset )
voidremove_point ( int offset )
voidset_color ( int point, Color color )
voidset_offset ( int point, float offset )

Property Descriptions

DefaultPoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )

Gradient’s colors returned as a PoolColorArray.

DefaultPoolRealArray( 0, 1 )

Gradient’s offsets returned as a PoolRealArray.

Method Descriptions

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

Returns the color of the ramp color at index point.

Returns the offset of the ramp color at index point.

  • int get_point_count ( ) const

Returns the number of colors in the ramp.

Returns the interpolated color specified by offset.

  • void remove_point ( int offset )

Removes the color at the index offset.

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

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.

Notify of
Inline Feedbacks
View all comments
Would love your thoughts, please comment.x