godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
godot-docs/classes/class_rdpipelinedepthstencilstate.rst
Godot Organization f9f2c80955 classref: Sync with current master branch (42c7f14)
2025-06-07 03:33:02 +00:00

447 lines
22 KiB
ReStructuredText
Raw Permalink Blame History

: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>`
Pipeline depth/stencil state (used by :ref:`RenderingDevice<class_RenderingDevice>`).
.. rst-class:: classref-introduction-group
Description
-----------
**RDPipelineDepthStencilState** controls the way depth and stencil comparisons are performed when sampling those values using :ref:`RenderingDevice<class_RenderingDevice>`.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
| :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`` |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_RDPipelineDepthStencilState_property_back_op_compare:
.. rst-class:: classref-property
:ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **back_op_compare** = ``7`` :ref:`🔗<class_RDPipelineDepthStencilState_property_back_op_compare>`
.. rst-class:: classref-property-setget
- |void| **set_back_op_compare**\ (\ value\: :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>`\ )
- :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **get_back_op_compare**\ (\ )
The method used for comparing the previous back stencil value and :ref:`back_op_reference<class_RDPipelineDepthStencilState_property_back_op_reference>`.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_back_op_compare_mask:
.. rst-class:: classref-property
:ref:`int<class_int>` **back_op_compare_mask** = ``0`` :ref:`🔗<class_RDPipelineDepthStencilState_property_back_op_compare_mask>`
.. rst-class:: classref-property-setget
- |void| **set_back_op_compare_mask**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_back_op_compare_mask**\ (\ )
Selects which bits from the back stencil value will be compared.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_back_op_depth_fail:
.. rst-class:: classref-property
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **back_op_depth_fail** = ``1`` :ref:`🔗<class_RDPipelineDepthStencilState_property_back_op_depth_fail>`
.. rst-class:: classref-property-setget
- |void| **set_back_op_depth_fail**\ (\ value\: :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>`\ )
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_back_op_depth_fail**\ (\ )
The operation to perform on the stencil buffer for back pixels that pass the stencil test but fail the depth test.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_back_op_fail:
.. rst-class:: classref-property
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **back_op_fail** = ``1`` :ref:`🔗<class_RDPipelineDepthStencilState_property_back_op_fail>`
.. rst-class:: classref-property-setget
- |void| **set_back_op_fail**\ (\ value\: :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>`\ )
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_back_op_fail**\ (\ )
The operation to perform on the stencil buffer for back pixels that fail the stencil test.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_back_op_pass:
.. rst-class:: classref-property
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **back_op_pass** = ``1`` :ref:`🔗<class_RDPipelineDepthStencilState_property_back_op_pass>`
.. rst-class:: classref-property-setget
- |void| **set_back_op_pass**\ (\ value\: :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>`\ )
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_back_op_pass**\ (\ )
The operation to perform on the stencil buffer for back pixels that pass the stencil test.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_back_op_reference:
.. rst-class:: classref-property
:ref:`int<class_int>` **back_op_reference** = ``0`` :ref:`🔗<class_RDPipelineDepthStencilState_property_back_op_reference>`
.. rst-class:: classref-property-setget
- |void| **set_back_op_reference**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_back_op_reference**\ (\ )
The value the previous back stencil value will be compared to.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_back_op_write_mask:
.. rst-class:: classref-property
:ref:`int<class_int>` **back_op_write_mask** = ``0`` :ref:`🔗<class_RDPipelineDepthStencilState_property_back_op_write_mask>`
.. rst-class:: classref-property-setget
- |void| **set_back_op_write_mask**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_back_op_write_mask**\ (\ )
Selects which bits from the back stencil value will be changed.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_depth_compare_operator:
.. rst-class:: classref-property
:ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **depth_compare_operator** = ``7`` :ref:`🔗<class_RDPipelineDepthStencilState_property_depth_compare_operator>`
.. rst-class:: classref-property-setget
- |void| **set_depth_compare_operator**\ (\ value\: :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>`\ )
- :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **get_depth_compare_operator**\ (\ )
The method used for comparing the previous and current depth values.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_depth_range_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **depth_range_max** = ``0.0`` :ref:`🔗<class_RDPipelineDepthStencilState_property_depth_range_max>`
.. rst-class:: classref-property-setget
- |void| **set_depth_range_max**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_depth_range_max**\ (\ )
The maximum depth that returns ``true`` for :ref:`enable_depth_range<class_RDPipelineDepthStencilState_property_enable_depth_range>`.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_depth_range_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **depth_range_min** = ``0.0`` :ref:`🔗<class_RDPipelineDepthStencilState_property_depth_range_min>`
.. rst-class:: classref-property-setget
- |void| **set_depth_range_min**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_depth_range_min**\ (\ )
The minimum depth that returns ``true`` for :ref:`enable_depth_range<class_RDPipelineDepthStencilState_property_enable_depth_range>`.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_enable_depth_range:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **enable_depth_range** = ``false`` :ref:`🔗<class_RDPipelineDepthStencilState_property_enable_depth_range>`
.. rst-class:: classref-property-setget
- |void| **set_enable_depth_range**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_enable_depth_range**\ (\ )
If ``true``, each depth value will be tested to see if it is between :ref:`depth_range_min<class_RDPipelineDepthStencilState_property_depth_range_min>` and :ref:`depth_range_max<class_RDPipelineDepthStencilState_property_depth_range_max>`. If it is outside of these values, it is discarded.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_enable_depth_test:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **enable_depth_test** = ``false`` :ref:`🔗<class_RDPipelineDepthStencilState_property_enable_depth_test>`
.. rst-class:: classref-property-setget
- |void| **set_enable_depth_test**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_enable_depth_test**\ (\ )
If ``true``, enables depth testing which allows objects to be automatically occluded by other objects based on their depth. This also allows objects to be partially occluded by other objects. If ``false``, objects will appear in the order they were drawn (like in Godot's 2D renderer).
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_enable_depth_write:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **enable_depth_write** = ``false`` :ref:`🔗<class_RDPipelineDepthStencilState_property_enable_depth_write>`
.. rst-class:: classref-property-setget
- |void| **set_enable_depth_write**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_enable_depth_write**\ (\ )
If ``true``, writes to the depth buffer whenever the depth test returns ``true``. Only works when enable_depth_test is also ``true``.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_enable_stencil:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **enable_stencil** = ``false`` :ref:`🔗<class_RDPipelineDepthStencilState_property_enable_stencil>`
.. rst-class:: classref-property-setget
- |void| **set_enable_stencil**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_enable_stencil**\ (\ )
If ``true``, enables stencil testing. There are separate stencil buffers for front-facing triangles and back-facing triangles. See properties that begin with "front_op" and properties with "back_op" for each.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_front_op_compare:
.. rst-class:: classref-property
:ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **front_op_compare** = ``7`` :ref:`🔗<class_RDPipelineDepthStencilState_property_front_op_compare>`
.. rst-class:: classref-property-setget
- |void| **set_front_op_compare**\ (\ value\: :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>`\ )
- :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **get_front_op_compare**\ (\ )
The method used for comparing the previous front stencil value and :ref:`front_op_reference<class_RDPipelineDepthStencilState_property_front_op_reference>`.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_front_op_compare_mask:
.. rst-class:: classref-property
:ref:`int<class_int>` **front_op_compare_mask** = ``0`` :ref:`🔗<class_RDPipelineDepthStencilState_property_front_op_compare_mask>`
.. rst-class:: classref-property-setget
- |void| **set_front_op_compare_mask**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_front_op_compare_mask**\ (\ )
Selects which bits from the front stencil value will be compared.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_front_op_depth_fail:
.. rst-class:: classref-property
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **front_op_depth_fail** = ``1`` :ref:`🔗<class_RDPipelineDepthStencilState_property_front_op_depth_fail>`
.. rst-class:: classref-property-setget
- |void| **set_front_op_depth_fail**\ (\ value\: :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>`\ )
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_front_op_depth_fail**\ (\ )
The operation to perform on the stencil buffer for front pixels that pass the stencil test but fail the depth test.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_front_op_fail:
.. rst-class:: classref-property
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **front_op_fail** = ``1`` :ref:`🔗<class_RDPipelineDepthStencilState_property_front_op_fail>`
.. rst-class:: classref-property-setget
- |void| **set_front_op_fail**\ (\ value\: :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>`\ )
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_front_op_fail**\ (\ )
The operation to perform on the stencil buffer for front pixels that fail the stencil test.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_front_op_pass:
.. rst-class:: classref-property
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **front_op_pass** = ``1`` :ref:`🔗<class_RDPipelineDepthStencilState_property_front_op_pass>`
.. rst-class:: classref-property-setget
- |void| **set_front_op_pass**\ (\ value\: :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>`\ )
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_front_op_pass**\ (\ )
The operation to perform on the stencil buffer for front pixels that pass the stencil test.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_front_op_reference:
.. rst-class:: classref-property
:ref:`int<class_int>` **front_op_reference** = ``0`` :ref:`🔗<class_RDPipelineDepthStencilState_property_front_op_reference>`
.. rst-class:: classref-property-setget
- |void| **set_front_op_reference**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_front_op_reference**\ (\ )
The value the previous front stencil value will be compared to.
.. rst-class:: classref-item-separator
----
.. _class_RDPipelineDepthStencilState_property_front_op_write_mask:
.. rst-class:: classref-property
:ref:`int<class_int>` **front_op_write_mask** = ``0`` :ref:`🔗<class_RDPipelineDepthStencilState_property_front_op_write_mask>`
.. rst-class:: classref-property-setget
- |void| **set_front_op_write_mask**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_front_op_write_mask**\ (\ )
Selects which bits from the front stencil value will be changed.
.. |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.)`
Reference in New Issue View Git Blame Copy Permalink