godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (2ba22d1)

Browse Source
This commit is contained in:
Godot Organization
2024-05-11 03:20:08 +00:00
parent 183d0e3147
commit 52e63d3864
34 changed files with 626 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
classes/class_openxrcompositionlayer.rst
View File

@@ -35,13 +35,15 @@ Properties
.. table::
:widths: auto
+---------------------------------------+-----------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`alpha_blend<class_OpenXRCompositionLayer_property_alpha_blend>` | ``false`` |
+---------------------------------------+-----------------------------------------------------------------------------+-----------+
| :ref:`SubViewport<class_SubViewport>` | :ref:`layer_viewport<class_OpenXRCompositionLayer_property_layer_viewport>` | |
+---------------------------------------+-----------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`sort_order<class_OpenXRCompositionLayer_property_sort_order>` | ``1`` |
+---------------------------------------+-----------------------------------------------------------------------------+-----------+
+---------------------------------------+-----------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`alpha_blend<class_OpenXRCompositionLayer_property_alpha_blend>` | ``false`` |
+---------------------------------------+-----------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`enable_hole_punch<class_OpenXRCompositionLayer_property_enable_hole_punch>` | ``false`` |
+---------------------------------------+-----------------------------------------------------------------------------------+-----------+
| :ref:`SubViewport<class_SubViewport>` | :ref:`layer_viewport<class_OpenXRCompositionLayer_property_layer_viewport>` | |
+---------------------------------------+-----------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`sort_order<class_OpenXRCompositionLayer_property_sort_order>` | ``1`` |
+---------------------------------------+-----------------------------------------------------------------------------------+-----------+
.. rst-class:: classref-reftable-group
@@ -85,6 +87,25 @@ Can be combined with :ref:`Viewport.transparent_bg<class_Viewport_property_trans
----
.. _class_OpenXRCompositionLayer_property_enable_hole_punch:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **enable_hole_punch** = ``false``
.. rst-class:: classref-property-setget
- |void| **set_enable_hole_punch**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_enable_hole_punch**\ (\ )
Enables a technique called "hole punching", which allows putting the composition layer behind the main projection layer (i.e. setting :ref:`sort_order<class_OpenXRCompositionLayer_property_sort_order>` to a negative value) while "punching a hole" through everything rendered by Godot so that the layer is still visible.
This can be used to create the illusion that the composition layer exists in the same 3D space as everything rendered by Godot, allowing objects to appear to pass both behind or in front of the composition layer.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_layer_viewport:
.. rst-class:: classref-property