.. 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/docs/gdscript/doc/classes/Gradient.xml. .. _class_Gradient: Gradient ======== **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. 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` **(** :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| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` point **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reverse` **(** **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`sample` **(** :ref:`float` offset **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_Gradient_InterpolationMode: .. rst-class:: classref-enumeration enum **InterpolationMode**: .. _class_Gradient_constant_GRADIENT_INTERPOLATE_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`InterpolationMode` **GRADIENT_INTERPOLATE_LINEAR** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Gradient_constant_GRADIENT_INTERPOLATE_CONSTANT: .. rst-class:: classref-enumeration-constant :ref:`InterpolationMode` **GRADIENT_INTERPOLATE_CONSTANT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Gradient_constant_GRADIENT_INTERPOLATE_CUBIC: .. rst-class:: classref-enumeration-constant :ref:`InterpolationMode` **GRADIENT_INTERPOLATE_CUBIC** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_Gradient_ColorSpace: .. rst-class:: classref-enumeration enum **ColorSpace**: .. _class_Gradient_constant_GRADIENT_COLOR_SPACE_SRGB: .. rst-class:: classref-enumeration-constant :ref:`ColorSpace` **GRADIENT_COLOR_SPACE_SRGB** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Gradient_constant_GRADIENT_COLOR_SPACE_LINEAR_SRGB: .. rst-class:: classref-enumeration-constant :ref:`ColorSpace` **GRADIENT_COLOR_SPACE_LINEAR_SRGB** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Gradient_constant_GRADIENT_COLOR_SPACE_OKLAB: .. rst-class:: classref-enumeration-constant :ref:`ColorSpace` **GRADIENT_COLOR_SPACE_OKLAB** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. 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)`` .. rst-class:: classref-property-setget - void **set_colors** **(** :ref:`PackedColorArray` value **)** - :ref:`PackedColorArray` **get_colors** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_property_interpolation_color_space: .. rst-class:: classref-property :ref:`ColorSpace` **interpolation_color_space** = ``0`` .. rst-class:: classref-property-setget - void **set_interpolation_color_space** **(** :ref:`ColorSpace` value **)** - :ref:`ColorSpace` **get_interpolation_color_space** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_property_interpolation_mode: .. rst-class:: classref-property :ref:`InterpolationMode` **interpolation_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_interpolation_mode** **(** :ref:`InterpolationMode` value **)** - :ref:`InterpolationMode` **get_interpolation_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_property_offsets: .. rst-class:: classref-property :ref:`PackedFloat32Array` **offsets** = ``PackedFloat32Array(0, 1)`` .. rst-class:: classref-property-setget - void **set_offsets** **(** :ref:`PackedFloat32Array` value **)** - :ref:`PackedFloat32Array` **get_offsets** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Gradient_method_add_point: .. rst-class:: classref-method void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_get_color: .. rst-class:: classref-method :ref:`Color` **get_color** **(** :ref:`int` point **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_get_offset: .. rst-class:: classref-method :ref:`float` **get_offset** **(** :ref:`int` point **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_get_point_count: .. rst-class:: classref-method :ref:`int` **get_point_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_remove_point: .. rst-class:: classref-method void **remove_point** **(** :ref:`int` point **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_reverse: .. rst-class:: classref-method void **reverse** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_sample: .. rst-class:: classref-method :ref:`Color` **sample** **(** :ref:`float` offset **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_set_color: .. rst-class:: classref-method void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Gradient_method_set_offset: .. rst-class:: classref-method void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)`