class_visualshadernodecompare.rst 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeCompare.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeCompare:
  6. VisualShaderNodeCompare
  7. =======================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Properties
  13. ----------
  14. +--------------------------------------------------------------------+--------------------------------------------------------------------+---+
  15. | :ref:`Condition<enum_VisualShaderNodeCompare_Condition>` | :ref:`condition<class_VisualShaderNodeCompare_property_condition>` | 0 |
  16. +--------------------------------------------------------------------+--------------------------------------------------------------------+---+
  17. | :ref:`Function<enum_VisualShaderNodeCompare_Function>` | :ref:`function<class_VisualShaderNodeCompare_property_function>` | 0 |
  18. +--------------------------------------------------------------------+--------------------------------------------------------------------+---+
  19. | :ref:`ComparsionType<enum_VisualShaderNodeCompare_ComparsionType>` | :ref:`type<class_VisualShaderNodeCompare_property_type>` | 0 |
  20. +--------------------------------------------------------------------+--------------------------------------------------------------------+---+
  21. Enumerations
  22. ------------
  23. .. _enum_VisualShaderNodeCompare_ComparsionType:
  24. .. _class_VisualShaderNodeCompare_constant_CTYPE_SCALAR:
  25. .. _class_VisualShaderNodeCompare_constant_CTYPE_VECTOR:
  26. .. _class_VisualShaderNodeCompare_constant_CTYPE_BOOLEAN:
  27. .. _class_VisualShaderNodeCompare_constant_CTYPE_TRANSFORM:
  28. enum **ComparsionType**:
  29. - **CTYPE_SCALAR** = **0**
  30. - **CTYPE_VECTOR** = **1**
  31. - **CTYPE_BOOLEAN** = **2**
  32. - **CTYPE_TRANSFORM** = **3**
  33. .. _enum_VisualShaderNodeCompare_Function:
  34. .. _class_VisualShaderNodeCompare_constant_FUNC_EQUAL:
  35. .. _class_VisualShaderNodeCompare_constant_FUNC_NOT_EQUAL:
  36. .. _class_VisualShaderNodeCompare_constant_FUNC_GREATER_THAN:
  37. .. _class_VisualShaderNodeCompare_constant_FUNC_GREATER_THAN_EQUAL:
  38. .. _class_VisualShaderNodeCompare_constant_FUNC_LESS_THAN:
  39. .. _class_VisualShaderNodeCompare_constant_FUNC_LESS_THAN_EQUAL:
  40. enum **Function**:
  41. - **FUNC_EQUAL** = **0**
  42. - **FUNC_NOT_EQUAL** = **1**
  43. - **FUNC_GREATER_THAN** = **2**
  44. - **FUNC_GREATER_THAN_EQUAL** = **3**
  45. - **FUNC_LESS_THAN** = **4**
  46. - **FUNC_LESS_THAN_EQUAL** = **5**
  47. .. _enum_VisualShaderNodeCompare_Condition:
  48. .. _class_VisualShaderNodeCompare_constant_COND_ALL:
  49. .. _class_VisualShaderNodeCompare_constant_COND_ANY:
  50. enum **Condition**:
  51. - **COND_ALL** = **0**
  52. - **COND_ANY** = **1**
  53. Property Descriptions
  54. ---------------------
  55. .. _class_VisualShaderNodeCompare_property_condition:
  56. - :ref:`Condition<enum_VisualShaderNodeCompare_Condition>` **condition**
  57. +-----------+----------------------+
  58. | *Default* | 0 |
  59. +-----------+----------------------+
  60. | *Setter* | set_condition(value) |
  61. +-----------+----------------------+
  62. | *Getter* | get_condition() |
  63. +-----------+----------------------+
  64. .. _class_VisualShaderNodeCompare_property_function:
  65. - :ref:`Function<enum_VisualShaderNodeCompare_Function>` **function**
  66. +-----------+---------------------+
  67. | *Default* | 0 |
  68. +-----------+---------------------+
  69. | *Setter* | set_function(value) |
  70. +-----------+---------------------+
  71. | *Getter* | get_function() |
  72. +-----------+---------------------+
  73. .. _class_VisualShaderNodeCompare_property_type:
  74. - :ref:`ComparsionType<enum_VisualShaderNodeCompare_ComparsionType>` **type**
  75. +-----------+----------------------------+
  76. | *Default* | 0 |
  77. +-----------+----------------------------+
  78. | *Setter* | set_comparsion_type(value) |
  79. +-----------+----------------------------+
  80. | *Getter* | get_comparsion_type() |
  81. +-----------+----------------------------+