:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineRasterizationState.xml. .. _class_RDPipelineRasterizationState: RDPipelineRasterizationState ============================ **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Pipeline rasterization state (used by :ref:`RenderingDevice`). .. rst-class:: classref-introduction-group Description ----------- This object is used by :ref:`RenderingDevice`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`PolygonCullMode` | :ref:`cull_mode` | ``0`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`depth_bias_clamp` | ``0.0`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`depth_bias_constant_factor` | ``0.0`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`depth_bias_enabled` | ``false`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`depth_bias_slope_factor` | ``0.0`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`discard_primitives` | ``false`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`enable_depth_clamp` | ``false`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`PolygonFrontFace` | :ref:`front_face` | ``0`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`line_width` | ``1.0`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`patch_control_points` | ``1`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`wireframe` | ``false`` | +----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_RDPipelineRasterizationState_property_cull_mode: .. rst-class:: classref-property :ref:`PolygonCullMode` **cull_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_cull_mode**\ (\ value\: :ref:`PolygonCullMode`\ ) - :ref:`PolygonCullMode` **get_cull_mode**\ (\ ) The cull mode to use when drawing polygons, which determines whether front faces or backfaces are hidden. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_depth_bias_clamp: .. rst-class:: classref-property :ref:`float` **depth_bias_clamp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_depth_bias_clamp**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_depth_bias_clamp**\ (\ ) A limit for how much each depth value can be offset. If negative, it serves as a minimum value, but if positive, it serves as a maximum value. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_depth_bias_constant_factor: .. rst-class:: classref-property :ref:`float` **depth_bias_constant_factor** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_depth_bias_constant_factor**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_depth_bias_constant_factor**\ (\ ) A constant offset added to each depth value. Applied after :ref:`depth_bias_slope_factor`. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_depth_bias_enabled: .. rst-class:: classref-property :ref:`bool` **depth_bias_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_depth_bias_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_depth_bias_enabled**\ (\ ) If ``true``, each generated depth value will by offset by some amount. The specific amount is generated per polygon based on the values of :ref:`depth_bias_slope_factor` and :ref:`depth_bias_constant_factor`. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_depth_bias_slope_factor: .. rst-class:: classref-property :ref:`float` **depth_bias_slope_factor** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_depth_bias_slope_factor**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_depth_bias_slope_factor**\ (\ ) A constant scale applied to the slope of each polygons' depth. Applied before :ref:`depth_bias_constant_factor`. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_discard_primitives: .. rst-class:: classref-property :ref:`bool` **discard_primitives** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_discard_primitives**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_discard_primitives**\ (\ ) If ``true``, primitives are discarded immediately before the rasterization stage. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_enable_depth_clamp: .. rst-class:: classref-property :ref:`bool` **enable_depth_clamp** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_enable_depth_clamp**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_enable_depth_clamp**\ (\ ) If ``true``, clamps depth values according to the minimum and maximum depth of the associated viewport. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_front_face: .. rst-class:: classref-property :ref:`PolygonFrontFace` **front_face** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_front_face**\ (\ value\: :ref:`PolygonFrontFace`\ ) - :ref:`PolygonFrontFace` **get_front_face**\ (\ ) The winding order to use to determine which face of a triangle is considered its front face. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_line_width: .. rst-class:: classref-property :ref:`float` **line_width** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_line_width**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_line_width**\ (\ ) The line width to use when drawing lines (in pixels). Thick lines may not be supported on all hardware. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_patch_control_points: .. rst-class:: classref-property :ref:`int` **patch_control_points** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_patch_control_points**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_patch_control_points**\ (\ ) The number of control points to use when drawing a patch with tessellation enabled. Higher values result in higher quality at the cost of performance. .. rst-class:: classref-item-separator ---- .. _class_RDPipelineRasterizationState_property_wireframe: .. rst-class:: classref-property :ref:`bool` **wireframe** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_wireframe**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_wireframe**\ (\ ) If ``true``, performs wireframe rendering for triangles instead of flat or textured rendering. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`