godot-docs/classes/class_gradienttexture.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GradientTexture.xml.

.. _class_GradientTexture:

GradientTexture
===============

**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

Gradient-filled texture.

.. rst-class:: classref-introduction-group

Description
-----------

GradientTexture uses a :ref:`Gradient<class_Gradient>` to fill the texture data. The gradient will be filled from left to right using colors obtained from the gradient. This means the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width<class_GradientTexture_property_width>`). See also :ref:`GradientTexture2D<class_GradientTexture2D>` and :ref:`CurveTexture<class_CurveTexture>`.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +---------------------------------+----------------------------------------------------------+-----------+
   | :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_GradientTexture_property_gradient>` |           |
   +---------------------------------+----------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>`         | :ref:`use_hdr<class_GradientTexture_property_use_hdr>`   | ``false`` |
   +---------------------------------+----------------------------------------------------------+-----------+
   | :ref:`int<class_int>`           | :ref:`width<class_GradientTexture_property_width>`       | ``2048``  |
   +---------------------------------+----------------------------------------------------------+-----------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_GradientTexture_property_gradient:

.. rst-class:: classref-property

:ref:`Gradient<class_Gradient>` **gradient**

.. rst-class:: classref-property-setget

- void **set_gradient** **(** :ref:`Gradient<class_Gradient>` value **)**
- :ref:`Gradient<class_Gradient>` **get_gradient** **(** **)**

The :ref:`Gradient<class_Gradient>` that will be used to fill the texture.

.. rst-class:: classref-item-separator

----

.. _class_GradientTexture_property_use_hdr:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **use_hdr** = ``false``

.. rst-class:: classref-property-setget

- void **set_use_hdr** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_using_hdr** **(** **)**

If ``true``, the generated texture will support high dynamic range (:ref:`Image.FORMAT_RGBAF<class_Image_constant_FORMAT_RGBAF>` format). This allows for glow effects to work if :ref:`Environment.glow_enabled<class_Environment_property_glow_enabled>` is ``true``. If ``false``, the generated texture will use low dynamic range; overbright colors will be clamped (:ref:`Image.FORMAT_RGBA8<class_Image_constant_FORMAT_RGBA8>` format).

.. rst-class:: classref-item-separator

----

.. _class_GradientTexture_property_width:

.. rst-class:: classref-property

:ref:`int<class_int>` **width** = ``2048``

.. rst-class:: classref-property-setget

- void **set_width** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_width** **(** **)**

The number of color samples that will be obtained from the :ref:`Gradient<class_Gradient>`.

.. |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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`