godot-docs/classes/class_gradienttexture.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GradientTexture.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_GradientTexture:

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

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

**Category:** Core

Brief Description
-----------------

Gradient filled texture.

Properties
----------

+---------------------------------+----------------------------------------------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_GradientTexture_property_gradient>` |
+---------------------------------+----------------------------------------------------------+
| :ref:`int<class_int>`           | :ref:`width<class_GradientTexture_property_width>`       |
+---------------------------------+----------------------------------------------------------+

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

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 that 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>`).

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

.. _class_GradientTexture_property_gradient:

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

+----------+---------------------+
| *Setter* | set_gradient(value) |
+----------+---------------------+
| *Getter* | get_gradient()      |
+----------+---------------------+

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

.. _class_GradientTexture_property_width:

- :ref:`int<class_int>` **width**

+----------+------------------+
| *Setter* | set_width(value) |
+----------+------------------+
| *Getter* | get_width()      |
+----------+------------------+

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