:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Gradient.xml. .. _class_Gradient: Gradient ======== **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A color transition. .. rst-class:: classref-introduction-group Description ----------- This resource describes a color transition by defining a set of colored points and how to interpolate between them. See also :ref:`Curve` which supports more complex easing methods, but does not support colors. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+ | :ref:`PackedColorArray` | :ref:`colors` | ``PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+ | :ref:`ColorSpace` | :ref:`interpolation_color_space` | ``0`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+ | :ref:`InterpolationMode` | :ref:`interpolation_mode` | ``0`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+ | :ref:`PackedFloat32Array` | :ref:`offsets` | ``PackedFloat32Array(0, 1)`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_point`\ (\ offset\: :ref:`float`, color\: :ref:`Color`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_color`\ (\ point\: :ref:`int`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_offset`\ (\ point\: :ref:`int`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_count`\ (\ ) |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_point`\ (\ point\: :ref:`int`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reverse`\ (\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`sample`\ (\ offset\: :ref:`float`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_color`\ (\ point\: :ref:`int`, color\: :ref:`Color`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_offset`\ (\ point\: :ref:`int`, offset\: :ref:`float`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_Gradient_InterpolationMode: .. rst-class:: classref-enumeration enum **InterpolationMode**: :ref:`🔗` .. _class_Gradient_constant_GRADIENT_INTERPOLATE_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`InterpolationMode` **GRADIENT_INTERPOLATE_LINEAR** = ``0`` Linear interpolation. .. _class_Gradient_constant_GRADIENT_INTERPOLATE_CONSTANT: .. rst-class:: classref-enumeration-constant :ref:`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. .. _class_Gradient_constant_GRADIENT_INTERPOLATE_CUBIC: .. rst-class:: classref-enumeration-constant :ref:`InterpolationMode` **GRADIENT_INTERPOLATE_CUBIC** = ``2`` Cubic interpolation. .. rst-class:: classref-item-separator ---- .. _enum_Gradient_ColorSpace: .. rst-class:: classref-enumeration enum **ColorSpace**: :ref:`🔗` .. _class_Gradient_constant_GRADIENT_COLOR_SPACE_SRGB: .. rst-class:: classref-enumeration-constant :ref:`ColorSpace` **GRADIENT_COLOR_SPACE_SRGB** = ``0`` sRGB color space. .. _class_Gradient_constant_GRADIENT_COLOR_SPACE_LINEAR_SRGB: .. rst-class:: classref-enumeration-constant :ref:`ColorSpace` **GRADIENT_COLOR_SPACE_LINEAR_SRGB** = ``1`` Linear sRGB color space. .. _class_Gradient_constant_GRADIENT_COLOR_SPACE_OKLAB: .. rst-class:: classref-enumeration-constant :ref:`ColorSpace` **GRADIENT_COLOR_SPACE_OKLAB** = ``2`` `Oklab `__ color space. This color space provides a smooth and uniform-looking transition between colors. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Gradient_property_colors: .. rst-class:: classref-property :ref:`PackedColorArray` **colors** = ``PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_colors**\ (\ value\: :ref:`PackedColorArray`\ ) - :ref:`PackedColorArray` **get_colors**\ (\ ) Gradient's colors as a :ref:`PackedColorArray`. \ **Note:** Setting this property updates all colors at once. To update any color individually use :ref:`set_color`. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedColorArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_Gradient_property_interpolation_color_space: .. rst-class:: classref-property :ref:`ColorSpace` **interpolation_color_space** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_interpolation_color_space**\ (\ value\: :ref:`ColorSpace`\ ) - :ref:`ColorSpace` **get_interpolation_color_space**\ (\ ) The color space used to interpolate between points of the gradient. It does not affect the returned colors, which will always be in sRGB space. See :ref:`ColorSpace` for available modes. \ **Note:** This setting has no effect when :ref:`interpolation_mode` is set to :ref:`GRADIENT_INTERPOLATE_CONSTANT`. .. rst-class:: classref-item-separator ---- .. _class_Gradient_property_interpolation_mode: .. rst-class:: classref-property :ref:`InterpolationMode` **interpolation_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_interpolation_mode**\ (\ value\: :ref:`InterpolationMode`\ ) - :ref:`InterpolationMode` **get_interpolation_mode**\ (\ ) The algorithm used to interpolate between points of the gradient. See :ref:`InterpolationMode` for available modes. .. rst-class:: classref-item-separator ---- .. _class_Gradient_property_offsets: .. rst-class:: classref-property :ref:`PackedFloat32Array` **offsets** = ``PackedFloat32Array(0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_offsets**\ (\ value\: :ref:`PackedFloat32Array`\ ) - :ref:`PackedFloat32Array` **get_offsets**\ (\ ) Gradient's offsets as a :ref:`PackedFloat32Array`. \ **Note:** Setting this property updates all offsets at once. To update any offset individually use :ref:`set_offset`. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedFloat32Array` for more details. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Gradient_method_add_point: .. rst-class:: classref-method |void| **add_point**\ (\ offset\: :ref:`float`, color\: :ref:`Color`\ ) :ref:`🔗` Adds the specified color to the gradient, with the specified offset. .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_get_color: .. rst-class:: classref-method :ref:`Color` **get_color**\ (\ point\: :ref:`int`\ ) :ref:`🔗` Returns the color of the gradient color at index ``point``. .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_get_offset: .. rst-class:: classref-method :ref:`float` **get_offset**\ (\ point\: :ref:`int`\ ) :ref:`🔗` Returns the offset of the gradient color at index ``point``. .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_get_point_count: .. rst-class:: classref-method :ref:`int` **get_point_count**\ (\ ) |const| :ref:`🔗` Returns the number of colors in the gradient. .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_remove_point: .. rst-class:: classref-method |void| **remove_point**\ (\ point\: :ref:`int`\ ) :ref:`🔗` Removes the color at index ``point``. .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_reverse: .. rst-class:: classref-method |void| **reverse**\ (\ ) :ref:`🔗` Reverses/mirrors the gradient. \ **Note:** This method mirrors all points around the middle of the gradient, which may produce unexpected results when :ref:`interpolation_mode` is set to :ref:`GRADIENT_INTERPOLATE_CONSTANT`. .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_sample: .. rst-class:: classref-method :ref:`Color` **sample**\ (\ offset\: :ref:`float`\ ) :ref:`🔗` Returns the interpolated color specified by ``offset``. .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_set_color: .. rst-class:: classref-method |void| **set_color**\ (\ point\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` Sets the color of the gradient color at index ``point``. .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_set_offset: .. rst-class:: classref-method |void| **set_offset**\ (\ point\: :ref:`int`, offset\: :ref:`float`\ ) :ref:`🔗` Sets the offset for the gradient 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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`