class_visualshadernodecolorop.rst 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  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/VisualShaderNodeColorOp.xml.
  6. .. _class_VisualShaderNodeColorOp:
  7. VisualShaderNodeColorOp
  8. =======================
  9. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A :ref:`Color<class_Color>` operator to be used within the visual shader graph.
  11. Description
  12. -----------
  13. Applies :ref:`operator<class_VisualShaderNodeColorOp_property_operator>` to two color inputs.
  14. Properties
  15. ----------
  16. +--------------------------------------------------------+------------------------------------------------------------------+-------+
  17. | :ref:`Operator<enum_VisualShaderNodeColorOp_Operator>` | :ref:`operator<class_VisualShaderNodeColorOp_property_operator>` | ``0`` |
  18. +--------------------------------------------------------+------------------------------------------------------------------+-------+
  19. Enumerations
  20. ------------
  21. .. _enum_VisualShaderNodeColorOp_Operator:
  22. .. _class_VisualShaderNodeColorOp_constant_OP_SCREEN:
  23. .. _class_VisualShaderNodeColorOp_constant_OP_DIFFERENCE:
  24. .. _class_VisualShaderNodeColorOp_constant_OP_DARKEN:
  25. .. _class_VisualShaderNodeColorOp_constant_OP_LIGHTEN:
  26. .. _class_VisualShaderNodeColorOp_constant_OP_OVERLAY:
  27. .. _class_VisualShaderNodeColorOp_constant_OP_DODGE:
  28. .. _class_VisualShaderNodeColorOp_constant_OP_BURN:
  29. .. _class_VisualShaderNodeColorOp_constant_OP_SOFT_LIGHT:
  30. .. _class_VisualShaderNodeColorOp_constant_OP_HARD_LIGHT:
  31. .. _class_VisualShaderNodeColorOp_constant_OP_MAX:
  32. enum **Operator**:
  33. - **OP_SCREEN** = **0** --- Produce a screen effect with the following formula:
  34. ::
  35. result = vec3(1.0) - (vec3(1.0) - a) * (vec3(1.0) - b);
  36. - **OP_DIFFERENCE** = **1** --- Produce a difference effect with the following formula:
  37. ::
  38. result = abs(a - b);
  39. - **OP_DARKEN** = **2** --- Produce a darken effect with the following formula:
  40. ::
  41. result = min(a, b);
  42. - **OP_LIGHTEN** = **3** --- Produce a lighten effect with the following formula:
  43. ::
  44. result = max(a, b);
  45. - **OP_OVERLAY** = **4** --- Produce an overlay effect with the following formula:
  46. ::
  47. for (int i = 0; i < 3; i++) {
  48. float base = a[i];
  49. float blend = b[i];
  50. if (base < 0.5) {
  51. result[i] = 2.0 * base * blend;
  52. } else {
  53. result[i] = 1.0 - 2.0 * (1.0 - blend) * (1.0 - base);
  54. }
  55. }
  56. - **OP_DODGE** = **5** --- Produce a dodge effect with the following formula:
  57. ::
  58. result = a / (vec3(1.0) - b);
  59. - **OP_BURN** = **6** --- Produce a burn effect with the following formula:
  60. ::
  61. result = vec3(1.0) - (vec3(1.0) - a) / b;
  62. - **OP_SOFT_LIGHT** = **7** --- Produce a soft light effect with the following formula:
  63. ::
  64. for (int i = 0; i < 3; i++) {
  65. float base = a[i];
  66. float blend = b[i];
  67. if (base < 0.5) {
  68. result[i] = base * (blend + 0.5);
  69. } else {
  70. result[i] = 1.0 - (1.0 - base) * (1.0 - (blend - 0.5));
  71. }
  72. }
  73. - **OP_HARD_LIGHT** = **8** --- Produce a hard light effect with the following formula:
  74. ::
  75. for (int i = 0; i < 3; i++) {
  76. float base = a[i];
  77. float blend = b[i];
  78. if (base < 0.5) {
  79. result[i] = base * (2.0 * blend);
  80. } else {
  81. result[i] = 1.0 - (1.0 - base) * (1.0 - 2.0 * (blend - 0.5));
  82. }
  83. }
  84. - **OP_MAX** = **9** --- Represents the size of the :ref:`Operator<enum_VisualShaderNodeColorOp_Operator>` enum.
  85. Property Descriptions
  86. ---------------------
  87. .. _class_VisualShaderNodeColorOp_property_operator:
  88. - :ref:`Operator<enum_VisualShaderNodeColorOp_Operator>` **operator**
  89. +-----------+---------------------+
  90. | *Default* | ``0`` |
  91. +-----------+---------------------+
  92. | *Setter* | set_operator(value) |
  93. +-----------+---------------------+
  94. | *Getter* | get_operator() |
  95. +-----------+---------------------+
  96. An operator to be applied to the inputs. See :ref:`Operator<enum_VisualShaderNodeColorOp_Operator>` for options.
  97. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  98. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  99. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  100. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  101. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  102. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`