mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
347 lines
16 KiB
ReStructuredText
347 lines
16 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_Gradient:
|
||
|
||
Gradient
|
||
========
|
||
|
||
**Hérite de :** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
||
|
||
Une transition de couleur.
|
||
|
||
.. 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<class_Curve>` which supports more complex easing methods, but does not support colors.
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Propriétés
|
||
--------------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+
|
||
| :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`colors<class_Gradient_property_colors>` | ``PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)`` |
|
||
+-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+
|
||
| :ref:`ColorSpace<enum_Gradient_ColorSpace>` | :ref:`interpolation_color_space<class_Gradient_property_interpolation_color_space>` | ``0`` |
|
||
+-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+
|
||
| :ref:`InterpolationMode<enum_Gradient_InterpolationMode>` | :ref:`interpolation_mode<class_Gradient_property_interpolation_mode>` | ``0`` |
|
||
+-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+
|
||
| :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`offsets<class_Gradient_property_offsets>` | ``PackedFloat32Array(0, 1)`` |
|
||
+-----------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------+
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Méthodes
|
||
----------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`add_point<class_Gradient_method_add_point>`\ (\ offset\: :ref:`float<class_float>`, color\: :ref:`Color<class_Color>`\ ) |
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Color<class_Color>` | :ref:`get_color<class_Gradient_method_get_color>`\ (\ point\: :ref:`int<class_int>`\ ) |
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`get_offset<class_Gradient_method_get_offset>`\ (\ point\: :ref:`int<class_int>`\ ) |
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`get_point_count<class_Gradient_method_get_point_count>`\ (\ ) |const| |
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`remove_point<class_Gradient_method_remove_point>`\ (\ point\: :ref:`int<class_int>`\ ) |
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`reverse<class_Gradient_method_reverse>`\ (\ ) |
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Color<class_Color>` | :ref:`sample<class_Gradient_method_sample>`\ (\ offset\: :ref:`float<class_float>`\ ) |
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_color<class_Gradient_method_set_color>`\ (\ point\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) |
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_offset<class_Gradient_method_set_offset>`\ (\ point\: :ref:`int<class_int>`, offset\: :ref:`float<class_float>`\ ) |
|
||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Énumérations
|
||
------------------------
|
||
|
||
.. _enum_Gradient_InterpolationMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **InterpolationMode**: :ref:`🔗<enum_Gradient_InterpolationMode>`
|
||
|
||
.. _class_Gradient_constant_GRADIENT_INTERPOLATE_LINEAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`InterpolationMode<enum_Gradient_InterpolationMode>` **GRADIENT_INTERPOLATE_LINEAR** = ``0``
|
||
|
||
Interpolation linéaire.
|
||
|
||
.. _class_Gradient_constant_GRADIENT_INTERPOLATE_CONSTANT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`InterpolationMode<enum_Gradient_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.
|
||
|
||
.. _class_Gradient_constant_GRADIENT_INTERPOLATE_CUBIC:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`InterpolationMode<enum_Gradient_InterpolationMode>` **GRADIENT_INTERPOLATE_CUBIC** = ``2``
|
||
|
||
Interpolation cubique.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Gradient_ColorSpace:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **ColorSpace**: :ref:`🔗<enum_Gradient_ColorSpace>`
|
||
|
||
.. _class_Gradient_constant_GRADIENT_COLOR_SPACE_SRGB:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ColorSpace<enum_Gradient_ColorSpace>` **GRADIENT_COLOR_SPACE_SRGB** = ``0``
|
||
|
||
Espace de couleur sRGB.
|
||
|
||
.. _class_Gradient_constant_GRADIENT_COLOR_SPACE_LINEAR_SRGB:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ColorSpace<enum_Gradient_ColorSpace>` **GRADIENT_COLOR_SPACE_LINEAR_SRGB** = ``1``
|
||
|
||
Espace de couleur sRGB linéaire.
|
||
|
||
.. _class_Gradient_constant_GRADIENT_COLOR_SPACE_OKLAB:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ColorSpace<enum_Gradient_ColorSpace>` **GRADIENT_COLOR_SPACE_OKLAB** = ``2``
|
||
|
||
Espace de couleur `Oklab <https://bottosson.github.io/posts/oklab/>`__. Cet espace de couleur offre une transition lisse et uniforme entre les couleurs.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Descriptions des propriétés
|
||
------------------------------------------------------
|
||
|
||
.. _class_Gradient_property_colors:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`PackedColorArray<class_PackedColorArray>` **colors** = ``PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)`` :ref:`🔗<class_Gradient_property_colors>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_colors**\ (\ value\: :ref:`PackedColorArray<class_PackedColorArray>`\ )
|
||
- :ref:`PackedColorArray<class_PackedColorArray>` **get_colors**\ (\ )
|
||
|
||
Les couleurs du gradient en tant que :ref:`PackedColorArray<class_PackedColorArray>`.
|
||
|
||
\ **Note :** Définir cette propriété met à jour toutes les couleurs à la fois. Pour mettre à jour n'importe quelle couleur individuellement, utilisez :ref:`set_color()<class_Gradient_method_set_color>`.
|
||
|
||
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedColorArray<class_PackedColorArray>` for more details.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_property_interpolation_color_space:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`ColorSpace<enum_Gradient_ColorSpace>` **interpolation_color_space** = ``0`` :ref:`🔗<class_Gradient_property_interpolation_color_space>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_interpolation_color_space**\ (\ value\: :ref:`ColorSpace<enum_Gradient_ColorSpace>`\ )
|
||
- :ref:`ColorSpace<enum_Gradient_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 :ref:`interpolation_mode<class_Gradient_property_interpolation_mode>` is set to :ref:`GRADIENT_INTERPOLATE_CONSTANT<class_Gradient_constant_GRADIENT_INTERPOLATE_CONSTANT>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_property_interpolation_mode:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`InterpolationMode<enum_Gradient_InterpolationMode>` **interpolation_mode** = ``0`` :ref:`🔗<class_Gradient_property_interpolation_mode>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_interpolation_mode**\ (\ value\: :ref:`InterpolationMode<enum_Gradient_InterpolationMode>`\ )
|
||
- :ref:`InterpolationMode<enum_Gradient_InterpolationMode>` **get_interpolation_mode**\ (\ )
|
||
|
||
L'algorithme utilisé pour interpoler entre les points du gradient.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_property_offsets:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`PackedFloat32Array<class_PackedFloat32Array>` **offsets** = ``PackedFloat32Array(0, 1)`` :ref:`🔗<class_Gradient_property_offsets>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_offsets**\ (\ value\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ )
|
||
- :ref:`PackedFloat32Array<class_PackedFloat32Array>` **get_offsets**\ (\ )
|
||
|
||
Les décalages du gradient en tant que :ref:`PackedFloat32Array<class_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 :ref:`set_offset()<class_Gradient_method_set_offset>`.
|
||
|
||
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedFloat32Array<class_PackedFloat32Array>` for more details.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Descriptions des méthodes
|
||
--------------------------------------------------
|
||
|
||
.. _class_Gradient_method_add_point:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **add_point**\ (\ offset\: :ref:`float<class_float>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Gradient_method_add_point>`
|
||
|
||
Ajoute la couleur spécifiée au gradient, avec le décalage spécifié.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_method_get_color:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Color<class_Color>` **get_color**\ (\ point\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Gradient_method_get_color>`
|
||
|
||
Renvoie la couleur du dégradé de couleurs à l'index ``point``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_method_get_offset:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **get_offset**\ (\ point\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Gradient_method_get_offset>`
|
||
|
||
Renvoie le décalage du gradient de couleur à l'index ``point``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_method_get_point_count:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **get_point_count**\ (\ ) |const| :ref:`🔗<class_Gradient_method_get_point_count>`
|
||
|
||
Renvoie le nombre de couleurs dans le gradient.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_method_remove_point:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **remove_point**\ (\ point\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Gradient_method_remove_point>`
|
||
|
||
Supprime la couleur à l'index ``point``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_method_reverse:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **reverse**\ (\ ) :ref:`🔗<class_Gradient_method_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 :ref:`interpolation_mode<class_Gradient_property_interpolation_mode>` est défini à :ref:`GRADIENT_INTERPOLATE_CONSTANT<class_Gradient_constant_GRADIENT_INTERPOLATE_CONSTANT>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_method_sample:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Color<class_Color>` **sample**\ (\ offset\: :ref:`float<class_float>`\ ) :ref:`🔗<class_Gradient_method_sample>`
|
||
|
||
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 :ref:`@GlobalScope.remap()<class_@GlobalScope_method_remap>` sur la valeur d'entrée avec les valeurs de sortie définies à ``0.0`` et ``1.0``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_method_set_color:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_color**\ (\ point\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Gradient_method_set_color>`
|
||
|
||
Définit la couleur du gradient de couleur à l'index ``point``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Gradient_method_set_offset:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_offset**\ (\ point\: :ref:`int<class_int>`, offset\: :ref:`float<class_float>`\ ) :ref:`🔗<class_Gradient_method_set_offset>`
|
||
|
||
Définit le décalage du gradient de couleur à l'index ``point``.
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (Cette méthode doit typiquement être redéfinie par l'utilisateur pour avoir un effet.)`
|
||
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
||
.. |const| replace:: :abbr:`const (Cette méthode n'a pas d'effets de bord. Elle ne modifie aucune des variables membres de l'instance.)`
|
||
.. |vararg| replace:: :abbr:`vararg (Cette méthode accepte n'importe quel nombre d'arguments après ceux décris ici.)`
|
||
.. |constructor| replace:: :abbr:`constructor (Cette méthode est utilisée pour construire un type.)`
|
||
.. |static| replace:: :abbr:`static (Cette méthode n'a pas besoin d'instance pour être appelée, elle peut donc être directement appelée en utilisant le nom de la classe.)`
|
||
.. |operator| replace:: :abbr:`operator (Cette méthode décrit un opérateur valide à utiliser avec ce type en tant qu'opérande gauche.)`
|
||
.. |bitfield| replace:: :abbr:`BitField (Cette valeur est un nombre entier composé d'un masque de bits des options suivantes.)`
|
||
.. |void| replace:: :abbr:`void (Aucune valeur de retour.)`
|