godot-docs/classes/class_visualshadernodefloatuniform.rst

:github_url: hide

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

.. _class_VisualShaderNodeFloatUniform:

VisualShaderNodeFloatUniform
============================

**Inherits:** :ref:`VisualShaderNodeUniform<class_VisualShaderNodeUniform>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

A scalar float uniform to be used within the visual shader graph.

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

Translated to ``uniform float`` in the shader language.

Properties
----------

+-----------------------------------------------------+---------------------------------------------------------------+---------+
| :ref:`Hint<enum_VisualShaderNodeFloatUniform_Hint>` | :ref:`hint<class_VisualShaderNodeFloatUniform_property_hint>` | ``0``   |
+-----------------------------------------------------+---------------------------------------------------------------+---------+
| :ref:`float<class_float>`                           | :ref:`max<class_VisualShaderNodeFloatUniform_property_max>`   | ``1.0`` |
+-----------------------------------------------------+---------------------------------------------------------------+---------+
| :ref:`float<class_float>`                           | :ref:`min<class_VisualShaderNodeFloatUniform_property_min>`   | ``0.0`` |
+-----------------------------------------------------+---------------------------------------------------------------+---------+
| :ref:`float<class_float>`                           | :ref:`step<class_VisualShaderNodeFloatUniform_property_step>` | ``0.1`` |
+-----------------------------------------------------+---------------------------------------------------------------+---------+

Enumerations
------------

.. _enum_VisualShaderNodeFloatUniform_Hint:

.. _class_VisualShaderNodeFloatUniform_constant_HINT_NONE:

.. _class_VisualShaderNodeFloatUniform_constant_HINT_RANGE:

.. _class_VisualShaderNodeFloatUniform_constant_HINT_RANGE_STEP:

enum **Hint**:

- **HINT_NONE** = **0** --- No hint used.

- **HINT_RANGE** = **1** --- A range hint for scalar value, which limits possible input values between :ref:`min<class_VisualShaderNodeFloatUniform_property_min>` and :ref:`max<class_VisualShaderNodeFloatUniform_property_max>`. Translated to ``hint_range(min, max)`` in shader code.

- **HINT_RANGE_STEP** = **2** --- A range hint for scalar value with step, which limits possible input values between :ref:`min<class_VisualShaderNodeFloatUniform_property_min>` and :ref:`max<class_VisualShaderNodeFloatUniform_property_max>`, with a step (increment) of :ref:`step<class_VisualShaderNodeFloatUniform_property_step>`). Translated to ``hint_range(min, max, step)`` in shader code.

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

.. _class_VisualShaderNodeFloatUniform_property_hint:

- :ref:`Hint<enum_VisualShaderNodeFloatUniform_Hint>` **hint**

+-----------+-----------------+
| *Default* | ``0``           |
+-----------+-----------------+
| *Setter*  | set_hint(value) |
+-----------+-----------------+
| *Getter*  | get_hint()      |
+-----------+-----------------+

A hint applied to the uniform, which controls the values it can take when set through the inspector.

----

.. _class_VisualShaderNodeFloatUniform_property_max:

- :ref:`float<class_float>` **max**

+-----------+----------------+
| *Default* | ``1.0``        |
+-----------+----------------+
| *Setter*  | set_max(value) |
+-----------+----------------+
| *Getter*  | get_max()      |
+-----------+----------------+

Minimum value for range hints. Used if :ref:`hint<class_VisualShaderNodeFloatUniform_property_hint>` is set to :ref:`HINT_RANGE<class_VisualShaderNodeFloatUniform_constant_HINT_RANGE>` or :ref:`HINT_RANGE_STEP<class_VisualShaderNodeFloatUniform_constant_HINT_RANGE_STEP>`.

----

.. _class_VisualShaderNodeFloatUniform_property_min:

- :ref:`float<class_float>` **min**

+-----------+----------------+
| *Default* | ``0.0``        |
+-----------+----------------+
| *Setter*  | set_min(value) |
+-----------+----------------+
| *Getter*  | get_min()      |
+-----------+----------------+

Maximum value for range hints. Used if :ref:`hint<class_VisualShaderNodeFloatUniform_property_hint>` is set to :ref:`HINT_RANGE<class_VisualShaderNodeFloatUniform_constant_HINT_RANGE>` or :ref:`HINT_RANGE_STEP<class_VisualShaderNodeFloatUniform_constant_HINT_RANGE_STEP>`.

----

.. _class_VisualShaderNodeFloatUniform_property_step:

- :ref:`float<class_float>` **step**

+-----------+-----------------+
| *Default* | ``0.1``         |
+-----------+-----------------+
| *Setter*  | set_step(value) |
+-----------+-----------------+
| *Getter*  | get_step()      |
+-----------+-----------------+

Step (increment) value for the range hint with step. Used if :ref:`hint<class_VisualShaderNodeFloatUniform_property_hint>` is set to :ref:`HINT_RANGE_STEP<class_VisualShaderNodeFloatUniform_constant_HINT_RANGE_STEP>`.