Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Gradient

Hérite de : Resource < RefCounted < Object

Une transition de couleur.

Description

This resource describes a color transition by defining a set of colored points and how to interpolate between them.

See also Curve which supports more complex easing methods, but does not support colors.

Propriétés

PackedColorArray	colors	`PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)`
ColorSpace	interpolation_color_space	`0`
InterpolationMode	interpolation_mode	`0`
PackedFloat32Array	offsets	`PackedFloat32Array(0, 1)`

Méthodes

void	add_point(offset: float, color: Color)
Color	get_color(point: int)
float	get_offset(point: int)
int	get_point_count() const
void	remove_point(point: int)
void	reverse()
Color	sample(offset: float)
void	set_color(point: int, color: Color)
void	set_offset(point: int, offset: float)

Énumérations

enum InterpolationMode: 🔗

InterpolationMode GRADIENT_INTERPOLATE_LINEAR = 0

Interpolation linéaire.

InterpolationMode GRADIENT_INTERPOLATE_CONSTANT = 1

Interpolation constante, la couleur change brusquement à chaque point et reste uniforme entre. Cela pourrait causer un crénelage visible lorsqu'elle est utilisée pour une texture de dégradé dans certains cas.

InterpolationMode GRADIENT_INTERPOLATE_CUBIC = 2

Interpolation cubique.

enum ColorSpace: 🔗

ColorSpace GRADIENT_COLOR_SPACE_SRGB = 0

Espace de couleur sRGB.

ColorSpace GRADIENT_COLOR_SPACE_LINEAR_SRGB = 1

Espace de couleur sRGB linéaire.

ColorSpace GRADIENT_COLOR_SPACE_OKLAB = 2

Espace de couleur Oklab. Cet espace de couleur offre une transition lisse et uniforme entre les couleurs.

Descriptions des propriétés

PackedColorArray colors = PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1) 🔗

void set_colors(value: PackedColorArray)
PackedColorArray get_colors()

Les couleurs du gradient en tant que PackedColorArray.

Note : Définir cette propriété met à jour toutes les couleurs à la fois. Pour mettre à jour n'importe quelle couleur individuellement, utilisez set_color().

Note: The returned array is copied and any changes to it will not update the original property value. See PackedColorArray for more details.

ColorSpace interpolation_color_space = 0 🔗

void set_interpolation_color_space(value: ColorSpace)
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 use nonlinear sRGB encoding.

Note: This setting has no effect when interpolation_mode is set to GRADIENT_INTERPOLATE_CONSTANT.

InterpolationMode interpolation_mode = 0 🔗

void set_interpolation_mode(value: InterpolationMode)
InterpolationMode get_interpolation_mode()

L'algorithme utilisé pour interpoler entre les points du gradient.

PackedFloat32Array offsets = PackedFloat32Array(0, 1) 🔗

void set_offsets(value: PackedFloat32Array)
PackedFloat32Array get_offsets()

Les décalages du gradient en tant que PackedFloat32Array.

Note : Définir cette propriété met à jour tous les décalages en même temps. Pour mettre à jour tout décalage individuellement, utilisez set_offset().

Note: The returned array is copied and any changes to it will not update the original property value. See PackedFloat32Array for more details.

Descriptions des méthodes

void add_point(offset: float, color: Color) 🔗

Ajoute la couleur spécifiée au gradient, avec le décalage spécifié.

Color get_color(point: int) 🔗

Renvoie la couleur du dégradé de couleurs à l'index point.

float get_offset(point: int) 🔗

Renvoie le décalage du gradient de couleur à l'index point.

int get_point_count() const 🔗

Renvoie le nombre de couleurs dans le gradient.

void remove_point(point: int) 🔗

Supprime la couleur à l'index point.

void reverse() 🔗

Retourne/inverse le gradient.

Note : Cette méthode reflète tous les points autour du milieu du gradient, qui peut produire des résultats inattendus lorsque interpolation_mode est défini à GRADIENT_INTERPOLATE_CONSTANT.

Color sample(offset: float) 🔗

Renvoie la couleur interpolée spécifiée par le décalage offset. offset doit être compris entre 0.0 et 1.0 (inclusifs). L'utilisation d'une valeur inférieure à 0.0 renverra la même couleur que 0.0, et l'utilisation d'une valeur supérieure à 1.0 renverra la même couleur que 1.0. Si votre valeur d'entrée n'est pas dans cet intervalle, envisagez d'utiliser @GlobalScope.remap() sur la valeur d'entrée avec les valeurs de sortie définies à 0.0 et 1.0.

void set_color(point: int, color: Color) 🔗

Définit la couleur du gradient de couleur à l'index point.

void set_offset(point: int, offset: float) 🔗

Définit le décalage du gradient de couleur à l'index point.