class_visualshadernodetransformfunc.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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 VisualShaderNodeTransformFunc.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeTransformFunc:
  6. VisualShaderNodeTransformFunc
  7. =============================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Computes a :ref:`Transform<class_Transform>` function within the visual shader graph.
  10. Description
  11. -----------
  12. Computes an inverse or transpose function on the provided :ref:`Transform<class_Transform>`.
  13. Properties
  14. ----------
  15. +--------------------------------------------------------------+------------------------------------------------------------------------+-------+
  16. | :ref:`Function<enum_VisualShaderNodeTransformFunc_Function>` | :ref:`function<class_VisualShaderNodeTransformFunc_property_function>` | ``0`` |
  17. +--------------------------------------------------------------+------------------------------------------------------------------------+-------+
  18. Enumerations
  19. ------------
  20. .. _enum_VisualShaderNodeTransformFunc_Function:
  21. .. _class_VisualShaderNodeTransformFunc_constant_FUNC_INVERSE:
  22. .. _class_VisualShaderNodeTransformFunc_constant_FUNC_TRANSPOSE:
  23. enum **Function**:
  24. - **FUNC_INVERSE** = **0** --- Perform the inverse operation on the :ref:`Transform<class_Transform>` matrix.
  25. - **FUNC_TRANSPOSE** = **1** --- Perform the transpose operation on the :ref:`Transform<class_Transform>` matrix.
  26. Property Descriptions
  27. ---------------------
  28. .. _class_VisualShaderNodeTransformFunc_property_function:
  29. - :ref:`Function<enum_VisualShaderNodeTransformFunc_Function>` **function**
  30. +-----------+---------------------+
  31. | *Default* | ``0`` |
  32. +-----------+---------------------+
  33. | *Setter* | set_function(value) |
  34. +-----------+---------------------+
  35. | *Getter* | get_function() |
  36. +-----------+---------------------+
  37. The function to be computed. See :ref:`Function<enum_VisualShaderNodeTransformFunc_Function>` for options.
  38. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  39. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  40. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`