class_visualshadernodeswitch.rst 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeSwitch.xml.
  6. .. _class_VisualShaderNodeSwitch:
  7. VisualShaderNodeSwitch
  8. ======================
  9. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A selector function for use within the visual shader graph.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Returns an associated value of the :ref:`op_type<class_VisualShaderNodeSwitch_property_op_type>` type if the provided boolean value is ``true`` or ``false``.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +---------------------------------------------------+---------------------------------------------------------------+-------+
  21. | :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` | :ref:`op_type<class_VisualShaderNodeSwitch_property_op_type>` | ``0`` |
  22. +---------------------------------------------------+---------------------------------------------------------------+-------+
  23. .. rst-class:: classref-section-separator
  24. ----
  25. .. rst-class:: classref-descriptions-group
  26. Enumerations
  27. ------------
  28. .. _enum_VisualShaderNodeSwitch_OpType:
  29. .. rst-class:: classref-enumeration
  30. enum **OpType**: :ref:`🔗<enum_VisualShaderNodeSwitch_OpType>`
  31. .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_FLOAT:
  32. .. rst-class:: classref-enumeration-constant
  33. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_FLOAT** = ``0``
  34. A floating-point scalar.
  35. .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_INT:
  36. .. rst-class:: classref-enumeration-constant
  37. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_INT** = ``1``
  38. An integer scalar.
  39. .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_UINT:
  40. .. rst-class:: classref-enumeration-constant
  41. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_UINT** = ``2``
  42. An unsigned integer scalar.
  43. .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_VECTOR_2D:
  44. .. rst-class:: classref-enumeration-constant
  45. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_VECTOR_2D** = ``3``
  46. A 2D vector type.
  47. .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_VECTOR_3D:
  48. .. rst-class:: classref-enumeration-constant
  49. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_VECTOR_3D** = ``4``
  50. A 3D vector type.
  51. .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_VECTOR_4D:
  52. .. rst-class:: classref-enumeration-constant
  53. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_VECTOR_4D** = ``5``
  54. A 4D vector type.
  55. .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_BOOLEAN:
  56. .. rst-class:: classref-enumeration-constant
  57. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_BOOLEAN** = ``6``
  58. A boolean type.
  59. .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_TRANSFORM:
  60. .. rst-class:: classref-enumeration-constant
  61. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_TRANSFORM** = ``7``
  62. A transform type.
  63. .. _class_VisualShaderNodeSwitch_constant_OP_TYPE_MAX:
  64. .. rst-class:: classref-enumeration-constant
  65. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_MAX** = ``8``
  66. Represents the size of the :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` enum.
  67. .. rst-class:: classref-section-separator
  68. ----
  69. .. rst-class:: classref-descriptions-group
  70. Property Descriptions
  71. ---------------------
  72. .. _class_VisualShaderNodeSwitch_property_op_type:
  73. .. rst-class:: classref-property
  74. :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **op_type** = ``0`` :ref:`🔗<class_VisualShaderNodeSwitch_property_op_type>`
  75. .. rst-class:: classref-property-setget
  76. - |void| **set_op_type**\ (\ value\: :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>`\ )
  77. - :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **get_op_type**\ (\ )
  78. A type of operands and returned value.
  79. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  80. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  81. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  82. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  83. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  84. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  85. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  86. .. |void| replace:: :abbr:`void (No return value.)`