Files
godot-docs/classes/class_visualshadernodeintop.rst
2020-03-13 17:17:50 +01:00

80 lines
2.6 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeIntOp.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShaderNodeIntOp:
VisualShaderNodeIntOp
=====================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
An integer scalar operator to be used within the visual shader graph.
Description
-----------
Applies :ref:`operator<class_VisualShaderNodeIntOp_property_operator>` to two integer inputs: ``a`` and ``b``.
Properties
----------
+------------------------------------------------------+----------------------------------------------------------------+-------+
| :ref:`Operator<enum_VisualShaderNodeIntOp_Operator>` | :ref:`operator<class_VisualShaderNodeIntOp_property_operator>` | ``0`` |
+------------------------------------------------------+----------------------------------------------------------------+-------+
Enumerations
------------
.. _enum_VisualShaderNodeIntOp_Operator:
.. _class_VisualShaderNodeIntOp_constant_OP_ADD:
.. _class_VisualShaderNodeIntOp_constant_OP_SUB:
.. _class_VisualShaderNodeIntOp_constant_OP_MUL:
.. _class_VisualShaderNodeIntOp_constant_OP_DIV:
.. _class_VisualShaderNodeIntOp_constant_OP_MOD:
.. _class_VisualShaderNodeIntOp_constant_OP_MAX:
.. _class_VisualShaderNodeIntOp_constant_OP_MIN:
enum **Operator**:
- **OP_ADD** = **0** --- Sums two numbers using ``a + b``.
- **OP_SUB** = **1** --- Subtracts two numbers using ``a - b``.
- **OP_MUL** = **2** --- Multiplies two numbers using ``a * b``.
- **OP_DIV** = **3** --- Divides two numbers using ``a / b``.
- **OP_MOD** = **4** --- Calculates the remainder of two numbers using ``a % b``.
- **OP_MAX** = **5** --- Returns the greater of two numbers. Translates to ``max(a, b)`` in the Godot Shader Language.
- **OP_MIN** = **6** --- Returns the lesser of two numbers. Translates to ``max(a, b)`` in the Godot Shader Language.
Property Descriptions
---------------------
.. _class_VisualShaderNodeIntOp_property_operator:
- :ref:`Operator<enum_VisualShaderNodeIntOp_Operator>` **operator**
+-----------+---------------------+
| *Default* | ``0`` |
+-----------+---------------------+
| *Setter* | set_operator(value) |
+-----------+---------------------+
| *Getter* | get_operator() |
+-----------+---------------------+
An operator to be applied to the inputs. See :ref:`Operator<enum_VisualShaderNodeIntOp_Operator>` for options.