class_rdpipelinerasterizationstate.rst 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  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/RDPipelineRasterizationState.xml.
  6. .. _class_RDPipelineRasterizationState:
  7. RDPipelineRasterizationState
  8. ============================
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. .. container:: contribute
  11. There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  12. .. rst-class:: classref-reftable-group
  13. Properties
  14. ----------
  15. .. table::
  16. :widths: auto
  17. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  18. | :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` | :ref:`cull_mode<class_RDPipelineRasterizationState_property_cull_mode>` | ``0`` |
  19. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  20. | :ref:`float<class_float>` | :ref:`depth_bias_clamp<class_RDPipelineRasterizationState_property_depth_bias_clamp>` | ``0.0`` |
  21. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  22. | :ref:`float<class_float>` | :ref:`depth_bias_constant_factor<class_RDPipelineRasterizationState_property_depth_bias_constant_factor>` | ``0.0`` |
  23. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  24. | :ref:`bool<class_bool>` | :ref:`depth_bias_enabled<class_RDPipelineRasterizationState_property_depth_bias_enabled>` | ``false`` |
  25. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  26. | :ref:`float<class_float>` | :ref:`depth_bias_slope_factor<class_RDPipelineRasterizationState_property_depth_bias_slope_factor>` | ``0.0`` |
  27. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  28. | :ref:`bool<class_bool>` | :ref:`discard_primitives<class_RDPipelineRasterizationState_property_discard_primitives>` | ``false`` |
  29. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  30. | :ref:`bool<class_bool>` | :ref:`enable_depth_clamp<class_RDPipelineRasterizationState_property_enable_depth_clamp>` | ``false`` |
  31. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  32. | :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` | :ref:`front_face<class_RDPipelineRasterizationState_property_front_face>` | ``0`` |
  33. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  34. | :ref:`float<class_float>` | :ref:`line_width<class_RDPipelineRasterizationState_property_line_width>` | ``1.0`` |
  35. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  36. | :ref:`int<class_int>` | :ref:`patch_control_points<class_RDPipelineRasterizationState_property_patch_control_points>` | ``1`` |
  37. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  38. | :ref:`bool<class_bool>` | :ref:`wireframe<class_RDPipelineRasterizationState_property_wireframe>` | ``false`` |
  39. +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
  40. .. rst-class:: classref-section-separator
  41. ----
  42. .. rst-class:: classref-descriptions-group
  43. Property Descriptions
  44. ---------------------
  45. .. _class_RDPipelineRasterizationState_property_cull_mode:
  46. .. rst-class:: classref-property
  47. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **cull_mode** = ``0``
  48. .. rst-class:: classref-property-setget
  49. - void **set_cull_mode** **(** :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` value **)**
  50. - :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **get_cull_mode** **(** **)**
  51. .. container:: contribute
  52. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  53. .. rst-class:: classref-item-separator
  54. ----
  55. .. _class_RDPipelineRasterizationState_property_depth_bias_clamp:
  56. .. rst-class:: classref-property
  57. :ref:`float<class_float>` **depth_bias_clamp** = ``0.0``
  58. .. rst-class:: classref-property-setget
  59. - void **set_depth_bias_clamp** **(** :ref:`float<class_float>` value **)**
  60. - :ref:`float<class_float>` **get_depth_bias_clamp** **(** **)**
  61. .. container:: contribute
  62. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  63. .. rst-class:: classref-item-separator
  64. ----
  65. .. _class_RDPipelineRasterizationState_property_depth_bias_constant_factor:
  66. .. rst-class:: classref-property
  67. :ref:`float<class_float>` **depth_bias_constant_factor** = ``0.0``
  68. .. rst-class:: classref-property-setget
  69. - void **set_depth_bias_constant_factor** **(** :ref:`float<class_float>` value **)**
  70. - :ref:`float<class_float>` **get_depth_bias_constant_factor** **(** **)**
  71. .. container:: contribute
  72. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  73. .. rst-class:: classref-item-separator
  74. ----
  75. .. _class_RDPipelineRasterizationState_property_depth_bias_enabled:
  76. .. rst-class:: classref-property
  77. :ref:`bool<class_bool>` **depth_bias_enabled** = ``false``
  78. .. rst-class:: classref-property-setget
  79. - void **set_depth_bias_enabled** **(** :ref:`bool<class_bool>` value **)**
  80. - :ref:`bool<class_bool>` **get_depth_bias_enabled** **(** **)**
  81. .. container:: contribute
  82. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  83. .. rst-class:: classref-item-separator
  84. ----
  85. .. _class_RDPipelineRasterizationState_property_depth_bias_slope_factor:
  86. .. rst-class:: classref-property
  87. :ref:`float<class_float>` **depth_bias_slope_factor** = ``0.0``
  88. .. rst-class:: classref-property-setget
  89. - void **set_depth_bias_slope_factor** **(** :ref:`float<class_float>` value **)**
  90. - :ref:`float<class_float>` **get_depth_bias_slope_factor** **(** **)**
  91. .. container:: contribute
  92. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  93. .. rst-class:: classref-item-separator
  94. ----
  95. .. _class_RDPipelineRasterizationState_property_discard_primitives:
  96. .. rst-class:: classref-property
  97. :ref:`bool<class_bool>` **discard_primitives** = ``false``
  98. .. rst-class:: classref-property-setget
  99. - void **set_discard_primitives** **(** :ref:`bool<class_bool>` value **)**
  100. - :ref:`bool<class_bool>` **get_discard_primitives** **(** **)**
  101. .. container:: contribute
  102. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  103. .. rst-class:: classref-item-separator
  104. ----
  105. .. _class_RDPipelineRasterizationState_property_enable_depth_clamp:
  106. .. rst-class:: classref-property
  107. :ref:`bool<class_bool>` **enable_depth_clamp** = ``false``
  108. .. rst-class:: classref-property-setget
  109. - void **set_enable_depth_clamp** **(** :ref:`bool<class_bool>` value **)**
  110. - :ref:`bool<class_bool>` **get_enable_depth_clamp** **(** **)**
  111. .. container:: contribute
  112. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  113. .. rst-class:: classref-item-separator
  114. ----
  115. .. _class_RDPipelineRasterizationState_property_front_face:
  116. .. rst-class:: classref-property
  117. :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` **front_face** = ``0``
  118. .. rst-class:: classref-property-setget
  119. - void **set_front_face** **(** :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` value **)**
  120. - :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` **get_front_face** **(** **)**
  121. .. container:: contribute
  122. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  123. .. rst-class:: classref-item-separator
  124. ----
  125. .. _class_RDPipelineRasterizationState_property_line_width:
  126. .. rst-class:: classref-property
  127. :ref:`float<class_float>` **line_width** = ``1.0``
  128. .. rst-class:: classref-property-setget
  129. - void **set_line_width** **(** :ref:`float<class_float>` value **)**
  130. - :ref:`float<class_float>` **get_line_width** **(** **)**
  131. .. container:: contribute
  132. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  133. .. rst-class:: classref-item-separator
  134. ----
  135. .. _class_RDPipelineRasterizationState_property_patch_control_points:
  136. .. rst-class:: classref-property
  137. :ref:`int<class_int>` **patch_control_points** = ``1``
  138. .. rst-class:: classref-property-setget
  139. - void **set_patch_control_points** **(** :ref:`int<class_int>` value **)**
  140. - :ref:`int<class_int>` **get_patch_control_points** **(** **)**
  141. .. container:: contribute
  142. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  143. .. rst-class:: classref-item-separator
  144. ----
  145. .. _class_RDPipelineRasterizationState_property_wireframe:
  146. .. rst-class:: classref-property
  147. :ref:`bool<class_bool>` **wireframe** = ``false``
  148. .. rst-class:: classref-property-setget
  149. - void **set_wireframe** **(** :ref:`bool<class_bool>` value **)**
  150. - :ref:`bool<class_bool>` **get_wireframe** **(** **)**
  151. .. container:: contribute
  152. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  153. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  154. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  155. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  156. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  157. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  158. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`