diff options
| author | David Snopek <dsnopek@gmail.com> | 2024-05-02 16:49:53 -0500 |
|---|---|---|
| committer | David Snopek <dsnopek@gmail.com> | 2024-05-07 10:02:32 -0500 |
| commit | 666bf60e3653279cea252ed06f8ab96ab03e5eaf (patch) | |
| tree | 253af049f6189bc7516f62702c4fbffd7dce5e33 /modules/openxr/doc_classes | |
| parent | 64520fe6741d8ec3c55e0c9618d3fadcda949f63 (diff) | |
| download | redot-engine-666bf60e3653279cea252ed06f8ab96ab03e5eaf.tar.gz | |
OpenXR: Allow composition layers to enable hole punching
Diffstat (limited to 'modules/openxr/doc_classes')
| -rw-r--r-- | modules/openxr/doc_classes/OpenXRCompositionLayer.xml | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/modules/openxr/doc_classes/OpenXRCompositionLayer.xml b/modules/openxr/doc_classes/OpenXRCompositionLayer.xml index b9c69075e1..6f4ac00f3e 100644 --- a/modules/openxr/doc_classes/OpenXRCompositionLayer.xml +++ b/modules/openxr/doc_classes/OpenXRCompositionLayer.xml @@ -32,6 +32,10 @@ Enables the blending the layer using its alpha channel. Can be combined with [member Viewport.transparent_bg] to give the layer a transparent background. </member> + <member name="enable_hole_punch" type="bool" setter="set_enable_hole_punch" getter="get_enable_hole_punch" default="false"> + Enables a technique called "hole punching", which allows putting the composition layer behind the main projection layer (i.e. setting [member 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. + </member> <member name="layer_viewport" type="SubViewport" setter="set_layer_viewport" getter="get_layer_viewport"> The [SubViewport] to render on the composition layer. </member> |