Files
godot-docs/classes/class_rdpipelinerasterizationstate.rst
2021-11-15 12:28:38 +01:00

204 lines
10 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the RDPipelineRasterizationState.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_RDPipelineRasterizationState:
RDPipelineRasterizationState
============================
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Properties
----------
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` | :ref:`cull_mode<class_RDPipelineRasterizationState_property_cull_mode>` | ``0`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`depth_bias_clamp<class_RDPipelineRasterizationState_property_depth_bias_clamp>` | ``0.0`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`depth_bias_constant_factor<class_RDPipelineRasterizationState_property_depth_bias_constant_factor>` | ``0.0`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`depth_bias_enable<class_RDPipelineRasterizationState_property_depth_bias_enable>` | ``false`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`depth_bias_slope_factor<class_RDPipelineRasterizationState_property_depth_bias_slope_factor>` | ``0.0`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`discard_primitives<class_RDPipelineRasterizationState_property_discard_primitives>` | ``false`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`enable_depth_clamp<class_RDPipelineRasterizationState_property_enable_depth_clamp>` | ``false`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` | :ref:`front_face<class_RDPipelineRasterizationState_property_front_face>` | ``0`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`line_width<class_RDPipelineRasterizationState_property_line_width>` | ``1.0`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`patch_control_points<class_RDPipelineRasterizationState_property_patch_control_points>` | ``1`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`wireframe<class_RDPipelineRasterizationState_property_wireframe>` | ``false`` |
+----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+
Property Descriptions
---------------------
.. _class_RDPipelineRasterizationState_property_cull_mode:
- :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **cull_mode**
+-----------+----------------------+
| *Default* | ``0`` |
+-----------+----------------------+
| *Setter* | set_cull_mode(value) |
+-----------+----------------------+
| *Getter* | get_cull_mode() |
+-----------+----------------------+
----
.. _class_RDPipelineRasterizationState_property_depth_bias_clamp:
- :ref:`float<class_float>` **depth_bias_clamp**
+-----------+-----------------------------+
| *Default* | ``0.0`` |
+-----------+-----------------------------+
| *Setter* | set_depth_bias_clamp(value) |
+-----------+-----------------------------+
| *Getter* | get_depth_bias_clamp() |
+-----------+-----------------------------+
----
.. _class_RDPipelineRasterizationState_property_depth_bias_constant_factor:
- :ref:`float<class_float>` **depth_bias_constant_factor**
+-----------+---------------------------------------+
| *Default* | ``0.0`` |
+-----------+---------------------------------------+
| *Setter* | set_depth_bias_constant_factor(value) |
+-----------+---------------------------------------+
| *Getter* | get_depth_bias_constant_factor() |
+-----------+---------------------------------------+
----
.. _class_RDPipelineRasterizationState_property_depth_bias_enable:
- :ref:`bool<class_bool>` **depth_bias_enable**
+-----------+------------------------------+
| *Default* | ``false`` |
+-----------+------------------------------+
| *Setter* | set_depth_bias_enable(value) |
+-----------+------------------------------+
| *Getter* | get_depth_bias_enable() |
+-----------+------------------------------+
----
.. _class_RDPipelineRasterizationState_property_depth_bias_slope_factor:
- :ref:`float<class_float>` **depth_bias_slope_factor**
+-----------+------------------------------------+
| *Default* | ``0.0`` |
+-----------+------------------------------------+
| *Setter* | set_depth_bias_slope_factor(value) |
+-----------+------------------------------------+
| *Getter* | get_depth_bias_slope_factor() |
+-----------+------------------------------------+
----
.. _class_RDPipelineRasterizationState_property_discard_primitives:
- :ref:`bool<class_bool>` **discard_primitives**
+-----------+-------------------------------+
| *Default* | ``false`` |
+-----------+-------------------------------+
| *Setter* | set_discard_primitives(value) |
+-----------+-------------------------------+
| *Getter* | get_discard_primitives() |
+-----------+-------------------------------+
----
.. _class_RDPipelineRasterizationState_property_enable_depth_clamp:
- :ref:`bool<class_bool>` **enable_depth_clamp**
+-----------+-------------------------------+
| *Default* | ``false`` |
+-----------+-------------------------------+
| *Setter* | set_enable_depth_clamp(value) |
+-----------+-------------------------------+
| *Getter* | get_enable_depth_clamp() |
+-----------+-------------------------------+
----
.. _class_RDPipelineRasterizationState_property_front_face:
- :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` **front_face**
+-----------+-----------------------+
| *Default* | ``0`` |
+-----------+-----------------------+
| *Setter* | set_front_face(value) |
+-----------+-----------------------+
| *Getter* | get_front_face() |
+-----------+-----------------------+
----
.. _class_RDPipelineRasterizationState_property_line_width:
- :ref:`float<class_float>` **line_width**
+-----------+-----------------------+
| *Default* | ``1.0`` |
+-----------+-----------------------+
| *Setter* | set_line_width(value) |
+-----------+-----------------------+
| *Getter* | get_line_width() |
+-----------+-----------------------+
----
.. _class_RDPipelineRasterizationState_property_patch_control_points:
- :ref:`int<class_int>` **patch_control_points**
+-----------+---------------------------------+
| *Default* | ``1`` |
+-----------+---------------------------------+
| *Setter* | set_patch_control_points(value) |
+-----------+---------------------------------+
| *Getter* | get_patch_control_points() |
+-----------+---------------------------------+
----
.. _class_RDPipelineRasterizationState_property_wireframe:
- :ref:`bool<class_bool>` **wireframe**
+-----------+----------------------+
| *Default* | ``false`` |
+-----------+----------------------+
| *Setter* | set_wireframe(value) |
+-----------+----------------------+
| *Getter* | get_wireframe() |
+-----------+----------------------+
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`