pandemonium_engine_docs/classes/class_visualshadernodescalarsmoothstep.rst

26 lines
1.2 KiB
ReStructuredText
Raw Normal View History

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarSmoothStep.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShaderNodeScalarSmoothStep:
VisualShaderNodeScalarSmoothStep
================================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Calculates a scalar SmoothStep function within the visual shader graph.
Description
-----------
Translates to ``smoothstep(edge0, edge1, x)`` in the shader language.
Returns ``0.0`` if ``x`` is smaller than ``edge0`` and ``1.0`` if ``x`` is larger than ``edge1``. Otherwise the return value is interpolated between ``0.0`` and ``1.0`` using Hermite polynomials.
.. |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.)`