:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFloatParameter.xml. .. _class_VisualShaderNodeFloatParameter: VisualShaderNodeFloatParameter ============================== **Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A scalar float parameter to be used within the visual shader graph. .. rst-class:: classref-introduction-group Description ----------- Translated to ``uniform float`` in the shader language. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`default_value` | ``0.0`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`default_value_enabled` | ``false`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ | :ref:`Hint` | :ref:`hint` | ``0`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`max` | ``1.0`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`min` | ``0.0`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`step` | ``0.1`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_VisualShaderNodeFloatParameter_Hint: .. rst-class:: classref-enumeration enum **Hint**: :ref:`🔗` .. _class_VisualShaderNodeFloatParameter_constant_HINT_NONE: .. rst-class:: classref-enumeration-constant :ref:`Hint` **HINT_NONE** = ``0`` No hint used. .. _class_VisualShaderNodeFloatParameter_constant_HINT_RANGE: .. rst-class:: classref-enumeration-constant :ref:`Hint` **HINT_RANGE** = ``1`` A range hint for scalar value, which limits possible input values between :ref:`min` and :ref:`max`. Translated to ``hint_range(min, max)`` in shader code. .. _class_VisualShaderNodeFloatParameter_constant_HINT_RANGE_STEP: .. rst-class:: classref-enumeration-constant :ref:`Hint` **HINT_RANGE_STEP** = ``2`` A range hint for scalar value with step, which limits possible input values between :ref:`min` and :ref:`max`, with a step (increment) of :ref:`step`). Translated to ``hint_range(min, max, step)`` in shader code. .. _class_VisualShaderNodeFloatParameter_constant_HINT_MAX: .. rst-class:: classref-enumeration-constant :ref:`Hint` **HINT_MAX** = ``3`` Represents the size of the :ref:`Hint` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_VisualShaderNodeFloatParameter_property_default_value: .. rst-class:: classref-property :ref:`float` **default_value** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_default_value**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_default_value**\ (\ ) A default value to be assigned within the shader. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeFloatParameter_property_default_value_enabled: .. rst-class:: classref-property :ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_default_value_enabled**\ (\ ) Enables usage of the :ref:`default_value`. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeFloatParameter_property_hint: .. rst-class:: classref-property :ref:`Hint` **hint** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_hint**\ (\ value\: :ref:`Hint`\ ) - :ref:`Hint` **get_hint**\ (\ ) A hint applied to the uniform, which controls the values it can take when set through the Inspector. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeFloatParameter_property_max: .. rst-class:: classref-property :ref:`float` **max** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_max**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_max**\ (\ ) Minimum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeFloatParameter_property_min: .. rst-class:: classref-property :ref:`float` **min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_min**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_min**\ (\ ) Maximum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeFloatParameter_property_step: .. rst-class:: classref-property :ref:`float` **step** = ``0.1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_step**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_step**\ (\ ) Step (increment) value for the range hint with step. Used if :ref:`hint` is set to :ref:`HINT_RANGE_STEP`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`