Files
godot-docs/classes/class_visualshadernodeswitch.rst
2022-07-27 13:59:06 +02:00

91 lines
3.3 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/VisualShaderNodeSwitch.xml.
.. _class_VisualShaderNodeSwitch:
VisualShaderNodeSwitch
======================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
A selector function for use within the visual shader graph.
Description
-----------
Returns an associated value of the ``op_type`` type if the provided boolean value is ``true`` or ``false``.
Properties
----------
+---------------------------------------------------+---------------------------------------------------------------+-------+
| :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` | :ref:`op_type<class_VisualShaderNodeSwitch_property_op_type>` | ``0`` |
+---------------------------------------------------+---------------------------------------------------------------+-------+
Enumerations
------------
.. _enum_VisualShaderNodeSwitch_OpType:
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_FLOAT:
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_INT:
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_VECTOR_2D:
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_VECTOR_3D:
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_VECTOR_4D:
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_BOOLEAN:
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_TRANSFORM:
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_MAX:
enum **OpType**:
- **OP_TYPE_FLOAT** = **0** --- A floating-point scalar.
- **OP_TYPE_INT** = **1** --- An integer scalar.
- **OP_TYPE_VECTOR_2D** = **2** --- A 2D vector type.
- **OP_TYPE_VECTOR_3D** = **3** --- A 3D vector type.
- **OP_TYPE_VECTOR_4D** = **4** --- A 4D vector type.
- **OP_TYPE_BOOLEAN** = **5** --- A boolean type.
- **OP_TYPE_TRANSFORM** = **6** --- A transform type.
- **OP_TYPE_MAX** = **7** --- Represents the size of the :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` enum.
Property Descriptions
---------------------
.. _class_VisualShaderNodeSwitch_property_op_type:
- :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **op_type**
+-----------+--------------------+
| *Default* | ``0`` |
+-----------+--------------------+
| *Setter* | set_op_type(value) |
+-----------+--------------------+
| *Getter* | get_op_type() |
+-----------+--------------------+
A type of operands and returned value.
.. |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.)`