class_visualshadernodemultiplyadd.rst 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/VisualShaderNodeMultiplyAdd.xml.
  6. .. _class_VisualShaderNodeMultiplyAdd:
  7. VisualShaderNodeMultiplyAdd
  8. ===========================
  9. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Performs a fused multiply-add operation within the visual shader graph.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Uses three operands to compute ``(a * b + c)`` expression.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +--------------------------------------------------------+--------------------------------------------------------------------+-------+
  21. | :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` | :ref:`op_type<class_VisualShaderNodeMultiplyAdd_property_op_type>` | ``0`` |
  22. +--------------------------------------------------------+--------------------------------------------------------------------+-------+
  23. .. rst-class:: classref-section-separator
  24. ----
  25. .. rst-class:: classref-descriptions-group
  26. Enumerations
  27. ------------
  28. .. _enum_VisualShaderNodeMultiplyAdd_OpType:
  29. .. rst-class:: classref-enumeration
  30. enum **OpType**:
  31. .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_SCALAR:
  32. .. rst-class:: classref-enumeration-constant
  33. :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` **OP_TYPE_SCALAR** = ``0``
  34. A floating-point scalar type.
  35. .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_VECTOR_2D:
  36. .. rst-class:: classref-enumeration-constant
  37. :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` **OP_TYPE_VECTOR_2D** = ``1``
  38. A 2D vector type.
  39. .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_VECTOR_3D:
  40. .. rst-class:: classref-enumeration-constant
  41. :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` **OP_TYPE_VECTOR_3D** = ``2``
  42. A 3D vector type.
  43. .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_VECTOR_4D:
  44. .. rst-class:: classref-enumeration-constant
  45. :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` **OP_TYPE_VECTOR_4D** = ``3``
  46. A 4D vector type.
  47. .. _class_VisualShaderNodeMultiplyAdd_constant_OP_TYPE_MAX:
  48. .. rst-class:: classref-enumeration-constant
  49. :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` **OP_TYPE_MAX** = ``4``
  50. Represents the size of the :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` enum.
  51. .. rst-class:: classref-section-separator
  52. ----
  53. .. rst-class:: classref-descriptions-group
  54. Property Descriptions
  55. ---------------------
  56. .. _class_VisualShaderNodeMultiplyAdd_property_op_type:
  57. .. rst-class:: classref-property
  58. :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` **op_type** = ``0``
  59. .. rst-class:: classref-property-setget
  60. - void **set_op_type** **(** :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` value **)**
  61. - :ref:`OpType<enum_VisualShaderNodeMultiplyAdd_OpType>` **get_op_type** **(** **)**
  62. A type of operands and returned value.
  63. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  64. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  65. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  66. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  67. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  68. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`