mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 21:29:07 +00:00
110 lines
4.5 KiB
ReStructuredText
110 lines
4.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.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:`RefCounted<class_RefCounted>` **<** :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:
|
|
|
|
.. _class_VisualShaderNodeIntOp_constant_OP_BITWISE_AND:
|
|
|
|
.. _class_VisualShaderNodeIntOp_constant_OP_BITWISE_OR:
|
|
|
|
.. _class_VisualShaderNodeIntOp_constant_OP_BITWISE_XOR:
|
|
|
|
.. _class_VisualShaderNodeIntOp_constant_OP_BITWISE_LEFT_SHIFT:
|
|
|
|
.. _class_VisualShaderNodeIntOp_constant_OP_BITWISE_RIGHT_SHIFT:
|
|
|
|
.. _class_VisualShaderNodeIntOp_constant_OP_ENUM_SIZE:
|
|
|
|
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.
|
|
|
|
- **OP_BITWISE_AND** = **7** --- Returns the result of bitwise ``AND`` operation on the integer. Translates to ``a & b`` in the Godot Shader Language.
|
|
|
|
- **OP_BITWISE_OR** = **8** --- Returns the result of bitwise ``OR`` operation for two integers. Translates to ``a | b`` in the Godot Shader Language.
|
|
|
|
- **OP_BITWISE_XOR** = **9** --- Returns the result of bitwise ``XOR`` operation for two integers. Translates to ``a ^ b`` in the Godot Shader Language.
|
|
|
|
- **OP_BITWISE_LEFT_SHIFT** = **10** --- Returns the result of bitwise left shift operation on the integer. Translates to ``a << b`` in the Godot Shader Language.
|
|
|
|
- **OP_BITWISE_RIGHT_SHIFT** = **11** --- Returns the result of bitwise right shift operation on the integer. Translates to ``a >> b`` in the Godot Shader Language.
|
|
|
|
- **OP_ENUM_SIZE** = **12** --- Represents the size of the :ref:`Operator<enum_VisualShaderNodeIntOp_Operator>` enum.
|
|
|
|
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.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|