: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/VisualShaderNodeScalarUniform.xml. .. _class_VisualShaderNodeScalarUniform: VisualShaderNodeScalarUniform ============================= **Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. 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_VisualShaderNodeScalarUniform_Hint: .. rst-class:: classref-enumeration enum **Hint**: .. _class_VisualShaderNodeScalarUniform_constant_HINT_NONE: .. rst-class:: classref-enumeration-constant :ref:`Hint` **HINT_NONE** = ``0`` No hint used. .. _class_VisualShaderNodeScalarUniform_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_VisualShaderNodeScalarUniform_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_VisualShaderNodeScalarUniform_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_VisualShaderNodeScalarUniform_property_default_value: .. rst-class:: classref-property :ref:`float` **default_value** = ``0.0`` .. rst-class:: classref-property-setget - void **set_default_value** **(** :ref:`float` value **)** - :ref:`float` **get_default_value** **(** **)** A default value to be assigned within the shader. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeScalarUniform_property_default_value_enabled: .. rst-class:: classref-property :ref:`bool` **default_value_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_default_value_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_default_value_enabled** **(** **)** Enables usage of the :ref:`default_value`. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeScalarUniform_property_hint: .. rst-class:: classref-property :ref:`Hint` **hint** = ``0`` .. rst-class:: classref-property-setget - void **set_hint** **(** :ref:`Hint` value **)** - :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_VisualShaderNodeScalarUniform_property_max: .. rst-class:: classref-property :ref:`float` **max** = ``1.0`` .. rst-class:: classref-property-setget - void **set_max** **(** :ref:`float` value **)** - :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_VisualShaderNodeScalarUniform_property_min: .. rst-class:: classref-property :ref:`float` **min** = ``0.0`` .. rst-class:: classref-property-setget - void **set_min** **(** :ref:`float` value **)** - :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_VisualShaderNodeScalarUniform_property_step: .. rst-class:: classref-property :ref:`float` **step** = ``0.1`` .. rst-class:: classref-property-setget - void **set_step** **(** :ref:`float` value **)** - :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.)` .. |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.)`