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 [code]true[/code] 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="protected_content" type="bool" setter="set_protected_content" getter="is_protected_content" default="false">
			If enabled, the OpenXR swapchain will be created with the [code]XR_SWAPCHAIN_CREATE_PROTECTED_CONTENT_BIT[/code] flag, which will protect its contents from CPU access.
			When used with an Android Surface, this may allow DRM content to be presented, and will only take effect when the Surface is first created; later changes to this property will have no effect.
		</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="swapchain_state_alpha_swizzle" type="int" setter="set_alpha_swizzle" getter="get_alpha_swizzle" enum="OpenXRCompositionLayer.Swizzle" default="3">
			The swizzle value for the alpha channel of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_blue_swizzle" type="int" setter="set_blue_swizzle" getter="get_blue_swizzle" enum="OpenXRCompositionLayer.Swizzle" default="2">
			The swizzle value for the blue channel of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_border_color" type="Color" setter="set_border_color" getter="get_border_color" default="Color(0, 0, 0, 0)">
			The border color of the swapchain state that is used when the wrap mode clamps to the border.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_green_swizzle" type="int" setter="set_green_swizzle" getter="get_green_swizzle" enum="OpenXRCompositionLayer.Swizzle" default="1">
			The swizzle value for the green channel of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_horizontal_wrap" type="int" setter="set_horizontal_wrap" getter="get_horizontal_wrap" enum="OpenXRCompositionLayer.Wrap" default="0">
			The horizontal wrap mode of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_mag_filter" type="int" setter="set_mag_filter" getter="get_mag_filter" enum="OpenXRCompositionLayer.Filter" default="1">
			The magnification filter of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_max_anisotropy" type="float" setter="set_max_anisotropy" getter="get_max_anisotropy" default="1.0">
			The max anisotropy of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_min_filter" type="int" setter="set_min_filter" getter="get_min_filter" enum="OpenXRCompositionLayer.Filter" default="1">
			The minification filter of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_mipmap_mode" type="int" setter="set_mipmap_mode" getter="get_mipmap_mode" enum="OpenXRCompositionLayer.MipmapMode" default="2">
			The mipmap mode of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_red_swizzle" type="int" setter="set_red_swizzle" getter="get_red_swizzle" enum="OpenXRCompositionLayer.Swizzle" default="0">
			The swizzle value for the red channel of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</member>
		<member name="swapchain_state_vertical_wrap" type="int" setter="set_vertical_wrap" getter="get_vertical_wrap" enum="OpenXRCompositionLayer.Wrap" default="0">
			The vertical wrap mode of the swapchain state.
			[b]Note:[/b] This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
		</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>
	<constants>
		<constant name="FILTER_NEAREST" value="0" enum="Filter">
			Perform nearest-neighbor filtering when sampling the texture.
		</constant>
		<constant name="FILTER_LINEAR" value="1" enum="Filter">
			Perform linear filtering when sampling the texture.
		</constant>
		<constant name="FILTER_CUBIC" value="2" enum="Filter">
			Perform cubic filtering when sampling the texture.
		</constant>
		<constant name="MIPMAP_MODE_DISABLED" value="0" enum="MipmapMode">
			Disable mipmapping.
			[b]Note:[/b] Mipmapping can only be disabled in the Compatibility renderer.
		</constant>
		<constant name="MIPMAP_MODE_NEAREST" value="1" enum="MipmapMode">
			Use the mipmap of the nearest resolution.
		</constant>
		<constant name="MIPMAP_MODE_LINEAR" value="2" enum="MipmapMode">
			Use linear interpolation of the two mipmaps of the nearest resolution.
		</constant>
		<constant name="WRAP_CLAMP_TO_BORDER" value="0" enum="Wrap">
			Clamp the texture to its specified border color.
		</constant>
		<constant name="WRAP_CLAMP_TO_EDGE" value="1" enum="Wrap">
			Clamp the texture to its edge color.
		</constant>
		<constant name="WRAP_REPEAT" value="2" enum="Wrap">
			Repeat the texture infinitely.
		</constant>
		<constant name="WRAP_MIRRORED_REPEAT" value="3" enum="Wrap">
			Repeat the texture infinitely, mirroring it on each repeat.
		</constant>
		<constant name="WRAP_MIRROR_CLAMP_TO_EDGE" value="4" enum="Wrap">
			Mirror the texture once and then clamp the texture to its edge color.
			[b]Note:[/b] This wrap mode is not available in the Compatibility renderer.
		</constant>
		<constant name="SWIZZLE_RED" value="0" enum="Swizzle">
			Maps a color channel to the value of the red channel.
		</constant>
		<constant name="SWIZZLE_GREEN" value="1" enum="Swizzle">
			Maps a color channel to the value of the green channel.
		</constant>
		<constant name="SWIZZLE_BLUE" value="2" enum="Swizzle">
			Maps a color channel to the value of the blue channel.
		</constant>
		<constant name="SWIZZLE_ALPHA" value="3" enum="Swizzle">
			Maps a color channel to the value of the alpha channel.
		</constant>
		<constant name="SWIZZLE_ZERO" value="4" enum="Swizzle">
			Maps a color channel to the value of zero.
		</constant>
		<constant name="SWIZZLE_ONE" value="5" enum="Swizzle">
			Maps a color channel to the value of one.
		</constant>
	</constants>
</class>