mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
481 lines
21 KiB
ReStructuredText
481 lines
21 KiB
ReStructuredText
: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>`
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. 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``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_back_op_compare** **(** :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` value **)**
|
|
- :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **get_back_op_compare** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_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``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_back_op_compare_mask** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_back_op_compare_mask** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. 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``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_back_op_depth_fail** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)**
|
|
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_back_op_depth_fail** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_back_op_fail:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **back_op_fail** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_back_op_fail** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)**
|
|
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_back_op_fail** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_back_op_pass:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **back_op_pass** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_back_op_pass** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)**
|
|
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_back_op_pass** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_back_op_reference:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **back_op_reference** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_back_op_reference** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_back_op_reference** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. 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``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_back_op_write_mask** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_back_op_write_mask** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_depth_compare_operator:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **depth_compare_operator** = ``7``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_depth_compare_operator** **(** :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` value **)**
|
|
- :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **get_depth_compare_operator** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_depth_range_max:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **depth_range_max** = ``0.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_depth_range_max** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_depth_range_max** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_depth_range_min:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **depth_range_min** = ``0.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_depth_range_min** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_depth_range_min** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_enable_depth_range:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **enable_depth_range** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_enable_depth_range** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **get_enable_depth_range** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_enable_depth_test:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **enable_depth_test** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_enable_depth_test** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **get_enable_depth_test** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_enable_depth_write:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **enable_depth_write** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_enable_depth_write** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **get_enable_depth_write** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_enable_stencil:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **enable_stencil** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_enable_stencil** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **get_enable_stencil** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_front_op_compare:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **front_op_compare** = ``7``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_front_op_compare** **(** :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` value **)**
|
|
- :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **get_front_op_compare** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_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``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_front_op_compare_mask** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_front_op_compare_mask** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. 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``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_front_op_depth_fail** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)**
|
|
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_front_op_depth_fail** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_front_op_fail:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **front_op_fail** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_front_op_fail** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)**
|
|
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_front_op_fail** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_front_op_pass:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **front_op_pass** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_front_op_pass** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)**
|
|
- :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_front_op_pass** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RDPipelineDepthStencilState_property_front_op_reference:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **front_op_reference** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_front_op_reference** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_front_op_reference** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. 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``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_front_op_write_mask** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_front_op_write_mask** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. |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.)`
|