godot-docs/classes/class_gradient.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Gradient.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Gradient:

Gradient
========

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_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 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
----------

+---------------------------------------------+-------------------------------------------------+----------------------------------------------+
| :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`colors<class_Gradient_property_colors>`   | ``PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )`` |
+---------------------------------------------+-------------------------------------------------+----------------------------------------------+
| :ref:`PoolRealArray<class_PoolRealArray>`   | :ref:`offsets<class_Gradient_property_offsets>` | ``PoolRealArray( 0, 1 )``                    |
+---------------------------------------------+-------------------------------------------------+----------------------------------------------+

Methods
-------

+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`add_point<class_Gradient_method_add_point>` **(** :ref:`float<class_float>` offset, :ref:`Color<class_Color>` color **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`get_color<class_Gradient_method_get_color>` **(** :ref:`int<class_int>` point **)**                                       |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_offset<class_Gradient_method_get_offset>` **(** :ref:`int<class_int>` point **)**                                     |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`     | :ref:`get_point_count<class_Gradient_method_get_point_count>` **(** **)** |const|                                               |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`interpolate<class_Gradient_method_interpolate>` **(** :ref:`float<class_float>` offset **)**                              |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`remove_point<class_Gradient_method_remove_point>` **(** :ref:`int<class_int>` point **)**                                 |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_color<class_Gradient_method_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_Color>` color **)**      |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_offset<class_Gradient_method_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)**   |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_Gradient_property_colors:

- :ref:`PoolColorArray<class_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 :ref:`PoolColorArray<class_PoolColorArray>`.

----

.. _class_Gradient_property_offsets:

- :ref:`PoolRealArray<class_PoolRealArray>` **offsets**

+-----------+---------------------------+
| *Default* | ``PoolRealArray( 0, 1 )`` |
+-----------+---------------------------+
| *Setter*  | set_offsets(value)        |
+-----------+---------------------------+
| *Getter*  | get_offsets()             |
+-----------+---------------------------+

Gradient's offsets returned as a :ref:`PoolRealArray<class_PoolRealArray>`.

Method Descriptions
-------------------

.. _class_Gradient_method_add_point:

- void **add_point** **(** :ref:`float<class_float>` offset, :ref:`Color<class_Color>` color **)**

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

----

.. _class_Gradient_method_get_color:

- :ref:`Color<class_Color>` **get_color** **(** :ref:`int<class_int>` point **)**

Returns the color of the ramp color at index ``point``.

----

.. _class_Gradient_method_get_offset:

- :ref:`float<class_float>` **get_offset** **(** :ref:`int<class_int>` point **)**

Returns the offset of the ramp color at index ``point``.

----

.. _class_Gradient_method_get_point_count:

- :ref:`int<class_int>` **get_point_count** **(** **)** |const|

Returns the number of colors in the ramp.

----

.. _class_Gradient_method_interpolate:

- :ref:`Color<class_Color>` **interpolate** **(** :ref:`float<class_float>` offset **)**

Returns the interpolated color specified by ``offset``.

----

.. _class_Gradient_method_remove_point:

- void **remove_point** **(** :ref:`int<class_int>` point **)**

Removes the color at the index ``point``.

----

.. _class_Gradient_method_set_color:

- void **set_color** **(** :ref:`int<class_int>` point, :ref:`Color<class_Color>` color **)**

Sets the color of the ramp color at index ``point``.

----

.. _class_Gradient_method_set_offset:

- void **set_offset** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)**

Sets the offset for the ramp color at index ``point``.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`