class_visualshadernodevectorscalarsmoothstep.rst 1.3 KB

1234567891011121314151617181920212223242526
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorScalarSmoothStep.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeVectorScalarSmoothStep:
  6. VisualShaderNodeVectorScalarSmoothStep
  7. ======================================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Calculates a vector SmoothStep function using scalar within the visual shader graph.
  10. Description
  11. -----------
  12. Translates to ``smoothstep(edge0, edge1, x)`` in the shader language, where ``x`` is a scalar.
  13. 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.
  14. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  15. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  16. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`