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

Hereda: Resource < RefCounted < Object

Una transición de color.

Descripción

Este recurso describe una transición de color definiendo un conjunto de puntos coloreados y cómo interpolar entre ellos.

Véase también Curve que soporta métodos de interpolación más complejos, pero no soporta colores.

Propiedades

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étodos

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)

Enumeraciones

enum InterpolationMode: 🔗

InterpolationMode GRADIENT_INTERPOLATE_LINEAR = 0

Interpolación lineal.

InterpolationMode GRADIENT_INTERPOLATE_CONSTANT = 1

Interpolación constante, el color cambia abruptamente en cada punto y se mantiene uniforme entre ellos. Esto puede causar aliasing visible cuando se utiliza para una textura de gradiente en algunos casos.

InterpolationMode GRADIENT_INTERPOLATE_CUBIC = 2

Interpolación cúbica.

enum ColorSpace: 🔗

ColorSpace GRADIENT_COLOR_SPACE_SRGB = 0

Espacio de color sRGB.

ColorSpace GRADIENT_COLOR_SPACE_LINEAR_SRGB = 1

Espacio de color sRGB lineal.

ColorSpace GRADIENT_COLOR_SPACE_OKLAB = 2

El espacio de color Oklab. Este espacio de color proporciona una transición suave y de aspecto uniforme entre los colores.

Descripciones de Propiedades

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

void set_colors(value: PackedColorArray)
PackedColorArray get_colors()

Los colores del gradiente como un PackedColorArray.

Nota: Establecer esta propiedad actualiza todos los colores a la vez. Para actualizar cualquier color individualmente, use 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()

El algoritmo utilizado para interpolar entre los puntos del gradiente.

PackedFloat32Array offsets = PackedFloat32Array(0, 1) 🔗

void set_offsets(value: PackedFloat32Array)
PackedFloat32Array get_offsets()

Los desplazamientos del gradiente como un PackedFloat32Array.

Nota: Establecer esta propiedad actualiza todos los desplazamientos a la vez. Para actualizar cualquier desplazamiento individualmente, use 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.

Descripciones de Métodos

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

Añade el color especificado al gradiente, con el desplazamiento especificado.

Color get_color(point: int) 🔗

Devuelve el color del gradiente en el índice point.

float get_offset(point: int) 🔗

Devuelve el desplazamiento del color del gradiente en el índice point.

int get_point_count() const 🔗

Devuelve el número de colores en el degradado.

void remove_point(point: int) 🔗

Elimina el color en el índice point.

void reverse() 🔗

Invierte/refleja el gradiente.

Nota: Este método refleja todos los puntos alrededor del centro del gradiente, lo que puede producir resultados inesperados cuando interpolation_mode está establecido como GRADIENT_INTERPOLATE_CONSTANT.

Color sample(offset: float) 🔗

Devuelve el color interpolado especificado por offset. offset debe estar entre 0.0 y 1.0 (inclusive). Usar un valor inferior a 0.0 devolverá el mismo color que 0.0, y usar un valor superior a 1.0 devolverá el mismo color que 1.0. Si su valor de entrada no está dentro de este rango, considera usar @GlobalScope.remap() en el valor de entrada con los valores de salida establecidos en 0.0 y 1.0.

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

Establece el color del color del gradiente en el índice point.

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

Establece el desplazamiento del color del gradiente en el índice point.