mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
170 lines
5.9 KiB
ReStructuredText
170 lines
5.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFloatOp.xml.
|
|
|
|
.. _class_VisualShaderNodeFloatOp:
|
|
|
|
VisualShaderNodeFloatOp
|
|
=======================
|
|
|
|
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
A floating-point scalar operator to be used within the visual shader graph.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Applies :ref:`operator<class_VisualShaderNodeFloatOp_property_operator>` to two floating-point inputs: ``a`` and ``b``.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+--------------------------------------------------------+------------------------------------------------------------------+-------+
|
|
| :ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` | :ref:`operator<class_VisualShaderNodeFloatOp_property_operator>` | ``0`` |
|
|
+--------------------------------------------------------+------------------------------------------------------------------+-------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualShaderNodeFloatOp_Operator:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **Operator**: :ref:`🔗<enum_VisualShaderNodeFloatOp_Operator>`
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_ADD:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_ADD** = ``0``
|
|
|
|
Sums two numbers using ``a + b``.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_SUB:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_SUB** = ``1``
|
|
|
|
Subtracts two numbers using ``a - b``.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_MUL:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_MUL** = ``2``
|
|
|
|
Multiplies two numbers using ``a * b``.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_DIV:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_DIV** = ``3``
|
|
|
|
Divides two numbers using ``a / b``.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_MOD:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_MOD** = ``4``
|
|
|
|
Calculates the remainder of two numbers. Translates to ``mod(a, b)`` in the Godot Shader Language.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_POW:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_POW** = ``5``
|
|
|
|
Raises the ``a`` to the power of ``b``. Translates to ``pow(a, b)`` in the Godot Shader Language.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_MAX** = ``6``
|
|
|
|
Returns the greater of two numbers. Translates to ``max(a, b)`` in the Godot Shader Language.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_MIN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_MIN** = ``7``
|
|
|
|
Returns the lesser of two numbers. Translates to ``min(a, b)`` in the Godot Shader Language.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_ATAN2:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_ATAN2** = ``8``
|
|
|
|
Returns the arc-tangent of the parameters. Translates to ``atan(a, b)`` in the Godot Shader Language.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_STEP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_STEP** = ``9``
|
|
|
|
Generates a step function by comparing ``b``\ (x) to ``a``\ (edge). Returns 0.0 if ``x`` is smaller than ``edge`` and otherwise 1.0. Translates to ``step(a, b)`` in the Godot Shader Language.
|
|
|
|
.. _class_VisualShaderNodeFloatOp_constant_OP_ENUM_SIZE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **OP_ENUM_SIZE** = ``10``
|
|
|
|
Represents the size of the :ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` enum.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeFloatOp_property_operator:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **operator** = ``0`` :ref:`🔗<class_VisualShaderNodeFloatOp_property_operator>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_operator**\ (\ value\: :ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>`\ )
|
|
- :ref:`Operator<enum_VisualShaderNodeFloatOp_Operator>` **get_operator**\ (\ )
|
|
|
|
An operator to be applied to the inputs.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
|
.. |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.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
|
.. |void| replace:: :abbr:`void (No return value.)`
|