class_visualshadernodefaceforward.rst 1.3 KB

123456789101112131415161718192021222324
  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 VisualShaderNodeFaceForward.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeFaceForward:
  6. VisualShaderNodeFaceForward
  7. ===========================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Returns the vector that points in the same direction as a reference vector within the visual shader graph.
  10. Description
  11. -----------
  12. Translates to ``faceforward(N, I, Nref)`` in the shader language. The function has three vector parameters: ``N``, the vector to orient, ``I``, the incident vector, and ``Nref``, the reference vector. If the dot product of ``I`` and ``Nref`` is smaller than zero the return value is ``N``. Otherwise, ``-N`` is returned.
  13. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  14. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  15. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`