virtualx-engine/modules/openxr/doc_classes/OpenXRCompositionLayer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="OpenXRCompositionLayer" inherits="Node3D" experimental="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		The parent class of all OpenXR composition layer nodes.
	</brief_description>
	<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.
		[b]Note:[/b] 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.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_android_surface">
			<return type="JavaObject" />
			<description>
				Returns a [JavaObject] representing an [code]android.view.Surface[/code] if [member use_android_surface] is enabled and OpenXR has created the surface. Otherwise, this will return [code]null[/code].
				[b]Note:[/b] The surface can only be created during an active OpenXR session. So, if [member use_android_surface] is enabled outside of an OpenXR session, it won't be created until a new session fully starts.
			</description>
		</method>
		<method name="intersects_ray" qualifiers="const">
			<return type="Vector2" />
			<param index="0" name="origin" type="Vector3" />
			<param index="1" name="direction" type="Vector3" />
			<description>
				Returns UV coordinates where the given ray intersects with the composition layer. [param origin] and [param direction] must be in global space.
				Returns [code]Vector2(-1.0, -1.0)[/code] if the ray doesn't intersect.
			</description>
		</method>
		<method name="is_natively_supported" qualifiers="const">
			<return type="bool" />
			<description>
				Returns true if the OpenXR runtime natively supports this composition layer type.
				[b]Note:[/b] This will only return an accurate result after the OpenXR session has started.
			</description>
		</method>
	</methods>
	<members>
		<member name="alpha_blend" type="bool" setter="set_alpha_blend" getter="get_alpha_blend" default="false">
			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="android_surface_size" type="Vector2i" setter="set_android_surface_size" getter="get_android_surface_size" default="Vector2i(1024, 1024)">
			The size of the Android surface to create if [member use_android_surface] is enabled.
		</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>
		<member name="sort_order" type="int" setter="set_sort_order" getter="get_sort_order" default="1">
			The sort order for this composition layer. Higher numbers will be shown in front of lower numbers.
			[b]Note:[/b] This will have no effect if a fallback mesh is being used.
		</member>
		<member name="use_android_surface" type="bool" setter="set_use_android_surface" getter="get_use_android_surface" default="false">
			If enabled, an Android surface will be created (with the dimensions from [member android_surface_size]) which will provide the 2D content for the composition layer, rather than using [member layer_viewport].
			See [method get_android_surface] for information about how to get the surface so that your application can draw to it.
			[b]Note:[/b] This will only work in Android builds.
		</member>
	</members>
</class>