Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
OpenXRCompositionLayer¶
Experimental: This class may be changed or removed in future versions.
Inherits: Node3D < Node < Object
Inherited By: OpenXRCompositionLayerCylinder, OpenXRCompositionLayerEquirect, OpenXRCompositionLayerQuad
The parent class of all OpenXR composition layer nodes.
Description¶
Composition layers allow 2D viewports to be displayed inside of the headset by the XR compositor through special projections that retain their quality. This allows for rendering clear text while keeping the layer at a native resolution.
Note: If the OpenXR runtime doesn't support the given composition layer type, a fallback mesh can be generated with a ViewportTexture, in order to emulate the composition layer.
Properties¶
|
||
|
Methods¶
intersects_ray(origin: Vector3, direction: Vector3) const |
|
is_natively_supported() const |
Property Descriptions¶
bool alpha_blend = false
Enables the blending the layer using its alpha channel.
Can be combined with Viewport.transparent_bg to give the layer a transparent background.
SubViewport layer_viewport
void set_layer_viewport(value: SubViewport)
SubViewport get_layer_viewport()
The SubViewport to render on the composition layer.
int sort_order = 1
The sort order for this composition layer. Higher numbers will be shown in front of lower numbers.
Note: This will have no effect if a fallback mesh is being used.
Method Descriptions¶
Vector2 intersects_ray(origin: Vector3, direction: Vector3) const
Returns UV coordinates where the given ray intersects with the composition layer. origin
and direction
must be in global space.
Returns Vector2(-1.0, -1.0)
if the ray doesn't intersect.
bool is_natively_supported() const
Returns true if the OpenXR runtime natively supports this composition layer type.
Note: This will only return an accurate result after the OpenXR session has started.