godot-docs/classes/class_rdpipelinedepthstencilstate.rst

: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/RDPipelineDepthStencilState.xml.

.. _class_RDPipelineDepthStencilState:

RDPipelineDepthStencilState
===========================

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`



Properties
----------

+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>`   | :ref:`back_op_compare<class_RDPipelineDepthStencilState_property_back_op_compare>`               | ``7``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`                                          | :ref:`back_op_compare_mask<class_RDPipelineDepthStencilState_property_back_op_compare_mask>`     | ``0``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` | :ref:`back_op_depth_fail<class_RDPipelineDepthStencilState_property_back_op_depth_fail>`         | ``1``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` | :ref:`back_op_fail<class_RDPipelineDepthStencilState_property_back_op_fail>`                     | ``1``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` | :ref:`back_op_pass<class_RDPipelineDepthStencilState_property_back_op_pass>`                     | ``1``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`                                          | :ref:`back_op_reference<class_RDPipelineDepthStencilState_property_back_op_reference>`           | ``0``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`                                          | :ref:`back_op_write_mask<class_RDPipelineDepthStencilState_property_back_op_write_mask>`         | ``0``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>`   | :ref:`depth_compare_operator<class_RDPipelineDepthStencilState_property_depth_compare_operator>` | ``7``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>`                                      | :ref:`depth_range_max<class_RDPipelineDepthStencilState_property_depth_range_max>`               | ``0.0``   |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>`                                      | :ref:`depth_range_min<class_RDPipelineDepthStencilState_property_depth_range_min>`               | ``0.0``   |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`                                        | :ref:`enable_depth_range<class_RDPipelineDepthStencilState_property_enable_depth_range>`         | ``false`` |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`                                        | :ref:`enable_depth_test<class_RDPipelineDepthStencilState_property_enable_depth_test>`           | ``false`` |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`                                        | :ref:`enable_depth_write<class_RDPipelineDepthStencilState_property_enable_depth_write>`         | ``false`` |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`                                        | :ref:`enable_stencil<class_RDPipelineDepthStencilState_property_enable_stencil>`                 | ``false`` |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>`   | :ref:`front_op_compare<class_RDPipelineDepthStencilState_property_front_op_compare>`             | ``7``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`                                          | :ref:`front_op_compare_mask<class_RDPipelineDepthStencilState_property_front_op_compare_mask>`   | ``0``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` | :ref:`front_op_depth_fail<class_RDPipelineDepthStencilState_property_front_op_depth_fail>`       | ``1``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` | :ref:`front_op_fail<class_RDPipelineDepthStencilState_property_front_op_fail>`                   | ``1``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` | :ref:`front_op_pass<class_RDPipelineDepthStencilState_property_front_op_pass>`                   | ``1``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`                                          | :ref:`front_op_reference<class_RDPipelineDepthStencilState_property_front_op_reference>`         | ``0``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`                                          | :ref:`front_op_write_mask<class_RDPipelineDepthStencilState_property_front_op_write_mask>`       | ``0``     |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+

Property Descriptions
---------------------

.. _class_RDPipelineDepthStencilState_property_back_op_compare:

- :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **back_op_compare**

+-----------+----------------------------+
| *Default* | ``7``                      |
+-----------+----------------------------+
| *Setter*  | set_back_op_compare(value) |
+-----------+----------------------------+
| *Getter*  | get_back_op_compare()      |
+-----------+----------------------------+

----

.. _class_RDPipelineDepthStencilState_property_back_op_compare_mask:

- :ref:`int<class_int>` **back_op_compare_mask**

+-----------+---------------------------------+
| *Default* | ``0``                           |
+-----------+---------------------------------+
| *Setter*  | set_back_op_compare_mask(value) |
+-----------+---------------------------------+
| *Getter*  | get_back_op_compare_mask()      |
+-----------+---------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_back_op_depth_fail:

- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **back_op_depth_fail**

+-----------+-------------------------------+
| *Default* | ``1``                         |
+-----------+-------------------------------+
| *Setter*  | set_back_op_depth_fail(value) |
+-----------+-------------------------------+
| *Getter*  | get_back_op_depth_fail()      |
+-----------+-------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_back_op_fail:

- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **back_op_fail**

+-----------+-------------------------+
| *Default* | ``1``                   |
+-----------+-------------------------+
| *Setter*  | set_back_op_fail(value) |
+-----------+-------------------------+
| *Getter*  | get_back_op_fail()      |
+-----------+-------------------------+

----

.. _class_RDPipelineDepthStencilState_property_back_op_pass:

- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **back_op_pass**

+-----------+-------------------------+
| *Default* | ``1``                   |
+-----------+-------------------------+
| *Setter*  | set_back_op_pass(value) |
+-----------+-------------------------+
| *Getter*  | get_back_op_pass()      |
+-----------+-------------------------+

----

.. _class_RDPipelineDepthStencilState_property_back_op_reference:

- :ref:`int<class_int>` **back_op_reference**

+-----------+------------------------------+
| *Default* | ``0``                        |
+-----------+------------------------------+
| *Setter*  | set_back_op_reference(value) |
+-----------+------------------------------+
| *Getter*  | get_back_op_reference()      |
+-----------+------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_back_op_write_mask:

- :ref:`int<class_int>` **back_op_write_mask**

+-----------+-------------------------------+
| *Default* | ``0``                         |
+-----------+-------------------------------+
| *Setter*  | set_back_op_write_mask(value) |
+-----------+-------------------------------+
| *Getter*  | get_back_op_write_mask()      |
+-----------+-------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_depth_compare_operator:

- :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **depth_compare_operator**

+-----------+-----------------------------------+
| *Default* | ``7``                             |
+-----------+-----------------------------------+
| *Setter*  | set_depth_compare_operator(value) |
+-----------+-----------------------------------+
| *Getter*  | get_depth_compare_operator()      |
+-----------+-----------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_depth_range_max:

- :ref:`float<class_float>` **depth_range_max**

+-----------+----------------------------+
| *Default* | ``0.0``                    |
+-----------+----------------------------+
| *Setter*  | set_depth_range_max(value) |
+-----------+----------------------------+
| *Getter*  | get_depth_range_max()      |
+-----------+----------------------------+

----

.. _class_RDPipelineDepthStencilState_property_depth_range_min:

- :ref:`float<class_float>` **depth_range_min**

+-----------+----------------------------+
| *Default* | ``0.0``                    |
+-----------+----------------------------+
| *Setter*  | set_depth_range_min(value) |
+-----------+----------------------------+
| *Getter*  | get_depth_range_min()      |
+-----------+----------------------------+

----

.. _class_RDPipelineDepthStencilState_property_enable_depth_range:

- :ref:`bool<class_bool>` **enable_depth_range**

+-----------+-------------------------------+
| *Default* | ``false``                     |
+-----------+-------------------------------+
| *Setter*  | set_enable_depth_range(value) |
+-----------+-------------------------------+
| *Getter*  | get_enable_depth_range()      |
+-----------+-------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_enable_depth_test:

- :ref:`bool<class_bool>` **enable_depth_test**

+-----------+------------------------------+
| *Default* | ``false``                    |
+-----------+------------------------------+
| *Setter*  | set_enable_depth_test(value) |
+-----------+------------------------------+
| *Getter*  | get_enable_depth_test()      |
+-----------+------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_enable_depth_write:

- :ref:`bool<class_bool>` **enable_depth_write**

+-----------+-------------------------------+
| *Default* | ``false``                     |
+-----------+-------------------------------+
| *Setter*  | set_enable_depth_write(value) |
+-----------+-------------------------------+
| *Getter*  | get_enable_depth_write()      |
+-----------+-------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_enable_stencil:

- :ref:`bool<class_bool>` **enable_stencil**

+-----------+---------------------------+
| *Default* | ``false``                 |
+-----------+---------------------------+
| *Setter*  | set_enable_stencil(value) |
+-----------+---------------------------+
| *Getter*  | get_enable_stencil()      |
+-----------+---------------------------+

----

.. _class_RDPipelineDepthStencilState_property_front_op_compare:

- :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **front_op_compare**

+-----------+-----------------------------+
| *Default* | ``7``                       |
+-----------+-----------------------------+
| *Setter*  | set_front_op_compare(value) |
+-----------+-----------------------------+
| *Getter*  | get_front_op_compare()      |
+-----------+-----------------------------+

----

.. _class_RDPipelineDepthStencilState_property_front_op_compare_mask:

- :ref:`int<class_int>` **front_op_compare_mask**

+-----------+----------------------------------+
| *Default* | ``0``                            |
+-----------+----------------------------------+
| *Setter*  | set_front_op_compare_mask(value) |
+-----------+----------------------------------+
| *Getter*  | get_front_op_compare_mask()      |
+-----------+----------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_front_op_depth_fail:

- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **front_op_depth_fail**

+-----------+--------------------------------+
| *Default* | ``1``                          |
+-----------+--------------------------------+
| *Setter*  | set_front_op_depth_fail(value) |
+-----------+--------------------------------+
| *Getter*  | get_front_op_depth_fail()      |
+-----------+--------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_front_op_fail:

- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **front_op_fail**

+-----------+--------------------------+
| *Default* | ``1``                    |
+-----------+--------------------------+
| *Setter*  | set_front_op_fail(value) |
+-----------+--------------------------+
| *Getter*  | get_front_op_fail()      |
+-----------+--------------------------+

----

.. _class_RDPipelineDepthStencilState_property_front_op_pass:

- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **front_op_pass**

+-----------+--------------------------+
| *Default* | ``1``                    |
+-----------+--------------------------+
| *Setter*  | set_front_op_pass(value) |
+-----------+--------------------------+
| *Getter*  | get_front_op_pass()      |
+-----------+--------------------------+

----

.. _class_RDPipelineDepthStencilState_property_front_op_reference:

- :ref:`int<class_int>` **front_op_reference**

+-----------+-------------------------------+
| *Default* | ``0``                         |
+-----------+-------------------------------+
| *Setter*  | set_front_op_reference(value) |
+-----------+-------------------------------+
| *Getter*  | get_front_op_reference()      |
+-----------+-------------------------------+

----

.. _class_RDPipelineDepthStencilState_property_front_op_write_mask:

- :ref:`int<class_int>` **front_op_write_mask**

+-----------+--------------------------------+
| *Default* | ``0``                          |
+-----------+--------------------------------+
| *Setter*  | set_front_op_write_mask(value) |
+-----------+--------------------------------+
| *Getter*  | get_front_op_write_mask()      |
+-----------+--------------------------------+

.. |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.)`