class_rdpipelinecolorblendstateattachment.rst 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the RDPipelineColorBlendStateAttachment.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_RDPipelineColorBlendStateAttachment:
  6. RDPipelineColorBlendStateAttachment
  7. ===================================
  8. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  12. | :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` | :ref:`alpha_blend_op<class_RDPipelineColorBlendStateAttachment_property_alpha_blend_op>` | ``0`` |
  13. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  14. | :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` | :ref:`color_blend_op<class_RDPipelineColorBlendStateAttachment_property_color_blend_op>` | ``0`` |
  15. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  16. | :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` | :ref:`dst_alpha_blend_factor<class_RDPipelineColorBlendStateAttachment_property_dst_alpha_blend_factor>` | ``0`` |
  17. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  18. | :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` | :ref:`dst_color_blend_factor<class_RDPipelineColorBlendStateAttachment_property_dst_color_blend_factor>` | ``0`` |
  19. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  20. | :ref:`bool<class_bool>` | :ref:`enable_blend<class_RDPipelineColorBlendStateAttachment_property_enable_blend>` | ``false`` |
  21. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  22. | :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` | :ref:`src_alpha_blend_factor<class_RDPipelineColorBlendStateAttachment_property_src_alpha_blend_factor>` | ``0`` |
  23. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  24. | :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` | :ref:`src_color_blend_factor<class_RDPipelineColorBlendStateAttachment_property_src_color_blend_factor>` | ``0`` |
  25. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  26. | :ref:`bool<class_bool>` | :ref:`write_a<class_RDPipelineColorBlendStateAttachment_property_write_a>` | ``true`` |
  27. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  28. | :ref:`bool<class_bool>` | :ref:`write_b<class_RDPipelineColorBlendStateAttachment_property_write_b>` | ``true`` |
  29. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  30. | :ref:`bool<class_bool>` | :ref:`write_g<class_RDPipelineColorBlendStateAttachment_property_write_g>` | ``true`` |
  31. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  32. | :ref:`bool<class_bool>` | :ref:`write_r<class_RDPipelineColorBlendStateAttachment_property_write_r>` | ``true`` |
  33. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+-----------+
  34. Methods
  35. -------
  36. +------+--------------------------------------------------------------------------------------------+
  37. | void | :ref:`set_as_mix<class_RDPipelineColorBlendStateAttachment_method_set_as_mix>` **(** **)** |
  38. +------+--------------------------------------------------------------------------------------------+
  39. Property Descriptions
  40. ---------------------
  41. .. _class_RDPipelineColorBlendStateAttachment_property_alpha_blend_op:
  42. - :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **alpha_blend_op**
  43. +-----------+---------------------------+
  44. | *Default* | ``0`` |
  45. +-----------+---------------------------+
  46. | *Setter* | set_alpha_blend_op(value) |
  47. +-----------+---------------------------+
  48. | *Getter* | get_alpha_blend_op() |
  49. +-----------+---------------------------+
  50. ----
  51. .. _class_RDPipelineColorBlendStateAttachment_property_color_blend_op:
  52. - :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **color_blend_op**
  53. +-----------+---------------------------+
  54. | *Default* | ``0`` |
  55. +-----------+---------------------------+
  56. | *Setter* | set_color_blend_op(value) |
  57. +-----------+---------------------------+
  58. | *Getter* | get_color_blend_op() |
  59. +-----------+---------------------------+
  60. ----
  61. .. _class_RDPipelineColorBlendStateAttachment_property_dst_alpha_blend_factor:
  62. - :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **dst_alpha_blend_factor**
  63. +-----------+-----------------------------------+
  64. | *Default* | ``0`` |
  65. +-----------+-----------------------------------+
  66. | *Setter* | set_dst_alpha_blend_factor(value) |
  67. +-----------+-----------------------------------+
  68. | *Getter* | get_dst_alpha_blend_factor() |
  69. +-----------+-----------------------------------+
  70. ----
  71. .. _class_RDPipelineColorBlendStateAttachment_property_dst_color_blend_factor:
  72. - :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **dst_color_blend_factor**
  73. +-----------+-----------------------------------+
  74. | *Default* | ``0`` |
  75. +-----------+-----------------------------------+
  76. | *Setter* | set_dst_color_blend_factor(value) |
  77. +-----------+-----------------------------------+
  78. | *Getter* | get_dst_color_blend_factor() |
  79. +-----------+-----------------------------------+
  80. ----
  81. .. _class_RDPipelineColorBlendStateAttachment_property_enable_blend:
  82. - :ref:`bool<class_bool>` **enable_blend**
  83. +-----------+-------------------------+
  84. | *Default* | ``false`` |
  85. +-----------+-------------------------+
  86. | *Setter* | set_enable_blend(value) |
  87. +-----------+-------------------------+
  88. | *Getter* | get_enable_blend() |
  89. +-----------+-------------------------+
  90. ----
  91. .. _class_RDPipelineColorBlendStateAttachment_property_src_alpha_blend_factor:
  92. - :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **src_alpha_blend_factor**
  93. +-----------+-----------------------------------+
  94. | *Default* | ``0`` |
  95. +-----------+-----------------------------------+
  96. | *Setter* | set_src_alpha_blend_factor(value) |
  97. +-----------+-----------------------------------+
  98. | *Getter* | get_src_alpha_blend_factor() |
  99. +-----------+-----------------------------------+
  100. ----
  101. .. _class_RDPipelineColorBlendStateAttachment_property_src_color_blend_factor:
  102. - :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **src_color_blend_factor**
  103. +-----------+-----------------------------------+
  104. | *Default* | ``0`` |
  105. +-----------+-----------------------------------+
  106. | *Setter* | set_src_color_blend_factor(value) |
  107. +-----------+-----------------------------------+
  108. | *Getter* | get_src_color_blend_factor() |
  109. +-----------+-----------------------------------+
  110. ----
  111. .. _class_RDPipelineColorBlendStateAttachment_property_write_a:
  112. - :ref:`bool<class_bool>` **write_a**
  113. +-----------+--------------------+
  114. | *Default* | ``true`` |
  115. +-----------+--------------------+
  116. | *Setter* | set_write_a(value) |
  117. +-----------+--------------------+
  118. | *Getter* | get_write_a() |
  119. +-----------+--------------------+
  120. ----
  121. .. _class_RDPipelineColorBlendStateAttachment_property_write_b:
  122. - :ref:`bool<class_bool>` **write_b**
  123. +-----------+--------------------+
  124. | *Default* | ``true`` |
  125. +-----------+--------------------+
  126. | *Setter* | set_write_b(value) |
  127. +-----------+--------------------+
  128. | *Getter* | get_write_b() |
  129. +-----------+--------------------+
  130. ----
  131. .. _class_RDPipelineColorBlendStateAttachment_property_write_g:
  132. - :ref:`bool<class_bool>` **write_g**
  133. +-----------+--------------------+
  134. | *Default* | ``true`` |
  135. +-----------+--------------------+
  136. | *Setter* | set_write_g(value) |
  137. +-----------+--------------------+
  138. | *Getter* | get_write_g() |
  139. +-----------+--------------------+
  140. ----
  141. .. _class_RDPipelineColorBlendStateAttachment_property_write_r:
  142. - :ref:`bool<class_bool>` **write_r**
  143. +-----------+--------------------+
  144. | *Default* | ``true`` |
  145. +-----------+--------------------+
  146. | *Setter* | set_write_r(value) |
  147. +-----------+--------------------+
  148. | *Getter* | get_write_r() |
  149. +-----------+--------------------+
  150. Method Descriptions
  151. -------------------
  152. .. _class_RDPipelineColorBlendStateAttachment_method_set_as_mix:
  153. - void **set_as_mix** **(** **)**
  154. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  155. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  156. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  157. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  158. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  159. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`