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

bool	alpha_blend	`false`
Vector2i	android_surface_size	`Vector2i(1024, 1024)`
bool	enable_hole_punch	`false`
SubViewport	layer_viewport
int	sort_order	`1`
Swizzle	swapchain_state_alpha_swizzle	`3`
Swizzle	swapchain_state_blue_swizzle	`2`
Color	swapchain_state_border_color	`Color(0, 0, 0, 0)`
Swizzle	swapchain_state_green_swizzle	`1`
Wrap	swapchain_state_horizontal_wrap	`0`
Filter	swapchain_state_mag_filter	`1`
float	swapchain_state_max_anisotropy	`1.0`
Filter	swapchain_state_min_filter	`1`
MipmapMode	swapchain_state_mipmap_mode	`2`
Swizzle	swapchain_state_red_swizzle	`0`
Wrap	swapchain_state_vertical_wrap	`0`
bool	use_android_surface	`false`

Methods

JavaObject	get_android_surface()
Vector2	intersects_ray(origin: Vector3, direction: Vector3) const
bool	is_natively_supported() const

Enumerations

enum Filter: 🔗

Filter FILTER_NEAREST = 0

Perform nearest-neighbor filtering when sampling the texture.

Filter FILTER_LINEAR = 1

Perform linear filtering when sampling the texture.

Filter FILTER_CUBIC = 2

Perform cubic filtering when sampling the texture.

enum MipmapMode: 🔗

MipmapMode MIPMAP_MODE_DISABLED = 0

Disable mipmapping.

Note: Mipmapping can only be disabled in the compatibility renderer.

MipmapMode MIPMAP_MODE_NEAREST = 1

Use the mipmap of the nearest resolution.

MipmapMode MIPMAP_MODE_LINEAR = 2

Use linear interpolation of the two mipmaps of the nearest resolution.

enum Wrap: 🔗

Wrap WRAP_CLAMP_TO_BORDER = 0

Clamp the texture to its specified border color.

Wrap WRAP_CLAMP_TO_EDGE = 1

Clamp the texture to its edge color.

Wrap WRAP_REPEAT = 2

Repeat the texture infinitely.

Wrap WRAP_MIRRORED_REPEAT = 3

Repeat the texture infinitely, mirroring it on each repeat.

Wrap WRAP_MIRROR_CLAMP_TO_EDGE = 4

Mirror the texture once and then clamp the texture to its edge color.

Note: This wrap mode is not available in the compatibility renderer.

enum Swizzle: 🔗

Swizzle SWIZZLE_RED = 0

Maps a color channel to the value of the red channel.

Swizzle SWIZZLE_GREEN = 1

Maps a color channel to the value of the green channel.

Swizzle SWIZZLE_BLUE = 2

Maps a color channel to the value of the blue channel.

Swizzle SWIZZLE_ALPHA = 3

Maps a color channel to the value of the alpha channel.

Swizzle SWIZZLE_ZERO = 4

Maps a color channel to the value of zero.

Swizzle SWIZZLE_ONE = 5

Maps a color channel to the value of one.

Property Descriptions

bool alpha_blend = false 🔗

void set_alpha_blend(value: bool)
bool get_alpha_blend()

Enables the blending the layer using its alpha channel.

Can be combined with Viewport.transparent_bg to give the layer a transparent background.

Vector2i android_surface_size = Vector2i(1024, 1024) 🔗

void set_android_surface_size(value: Vector2i)
Vector2i get_android_surface_size()

The size of the Android surface to create if use_android_surface is enabled.

bool enable_hole_punch = false 🔗

void set_enable_hole_punch(value: bool)
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 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.

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 🔗

void set_sort_order(value: int)
int get_sort_order()

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.

Swizzle swapchain_state_alpha_swizzle = 3 🔗

void set_alpha_swizzle(value: Swizzle)
Swizzle get_alpha_swizzle()

The swizzle value for the alpha channel of the swapchain state.