class_visualshadernodemultiplyadd.rst 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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 VisualShaderNodeMultiplyAdd.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeMultiplyAdd:
  6. VisualShaderNodeMultiplyAdd
  7. ===========================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Performs a fused multiply-add operation within the visual shader graph.
  10. Description
  11. -----------
  12. Uses three operands to compute ``(a * b + c)`` expression.
  13. Properties
  14. ----------
  15. +--------------------------------------------------------+--------------------------------------------------------------------+-------+
  16. | :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` | :ref:`op_type<class_VisualShaderNodeMultiplyAdd_property_op_type>` | ``0`` |
  17. +--------------------------------------------------------+--------------------------------------------------------------------+-------+
  18. Enumerations
  19. ------------
  20. .. _enum_VisualShaderNodeMultiplyAdd_OpType:
  21. .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_SCALAR:
  22. .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_VECTOR_2D:
  23. .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_VECTOR_3D:
  24. .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_MAX:
  25. enum **OpType**:
  26. - **OP_TYPE_SCALAR** = **0** --- A floating-point scalar type.
  27. - **OP_TYPE_VECTOR_2D** = **1** --- A 2D vector type.
  28. - **OP_TYPE_VECTOR_3D** = **2** --- A 3D vector type.
  29. - **OP_TYPE_MAX** = **3** --- Represents the size of the :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` enum.
  30. Property Descriptions
  31. ---------------------
  32. .. _class_VisualShaderNodeMultiplyAdd_property_op_type:
  33. - :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` **op_type**
  34. +-----------+--------------------+
  35. | *Default* | ``0`` |
  36. +-----------+--------------------+
  37. | *Setter* | set_op_type(value) |
  38. +-----------+--------------------+
  39. | *Getter* | get_op_type() |
  40. +-----------+--------------------+
  41. A type of operands and returned value.
  42. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  43. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  44. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  45. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  46. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  47. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`