:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Gradient.xml. .. _class_Gradient: Gradient ======== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`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 :ref:`Curve` which supports more complex easing methods, but does not support colors. Properties ---------- +-----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------------------+ | :ref:`PoolColorArray` | :ref:`colors` | ``PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )`` | +-----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------------------+ | :ref:`InterpolationMode` | :ref:`interpolation_mode` | ``0`` | +-----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------------------+ | :ref:`PoolRealArray` | :ref:`offsets` | ``PoolRealArray( 0, 1 )`` | +-----------------------------------------------------------+-----------------------------------------------------------------------+----------------------------------------------+ Methods ------- +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_count` **(** **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` point **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Gradient_InterpolationMode: .. _class_Gradient_constant_GRADIENT_INTERPOLATE_LINEAR: .. _class_Gradient_constant_GRADIENT_INTERPOLATE_CONSTANT: .. _class_Gradient_constant_GRADIENT_INTERPOLATE_CUBIC: 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 --------------------- .. _class_Gradient_property_colors: - :ref:`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_Gradient_property_interpolation_mode: - :ref:`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 :ref:`InterpolationMode` for available modes. ---- .. _class_Gradient_property_offsets: - :ref:`PoolRealArray` **offsets** +-----------+---------------------------+ | *Default* | ``PoolRealArray( 0, 1 )`` | +-----------+---------------------------+ | *Setter* | set_offsets(value) | +-----------+---------------------------+ | *Getter* | get_offsets() | +-----------+---------------------------+ Gradient's offsets returned as a :ref:`PoolRealArray`. Method Descriptions ------------------- .. _class_Gradient_method_add_point: - void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** Adds the specified color to the end of the ramp, with the specified offset. ---- .. _class_Gradient_method_get_color: - :ref:`Color` **get_color** **(** :ref:`int` point **)** Returns the color of the ramp color at index ``point``. ---- .. _class_Gradient_method_get_offset: - :ref:`float` **get_offset** **(** :ref:`int` point **)** Returns the offset of the ramp color at index ``point``. ---- .. _class_Gradient_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** |const| Returns the number of colors in the ramp. ---- .. _class_Gradient_method_interpolate: - :ref:`Color` **interpolate** **(** :ref:`float` offset **)** Returns the interpolated color specified by ``offset``. ---- .. _class_Gradient_method_remove_point: - void **remove_point** **(** :ref:`int` point **)** Removes the color at the index ``point``. ---- .. _class_Gradient_method_set_color: - void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** Sets the color of the ramp color at index ``point``. ---- .. _class_Gradient_method_set_offset: - void **set_offset** **(** :ref:`int` point, :ref:`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.)`