Top Description Fields Constructors Methods
org.lwjgl.openxr

public final Class EXTXOverlay

extends Object
Class Inheritance

The XR_EXTX_overlay extension.

Application developers may desire to implement an OpenXR application that renders content on top of another OpenXR application. These additional applications will execute in a separate process, create a separate session, generate separate content, but want the OpenXR runtime to composite their content on top of the main OpenXR application. Examples of these applications might include:

This extension introduces the concept of "Overlay Sessions" in order to expose this usage model.

This extension allows:

To enable the functionality of this extension, an application must pass the name of the extension into CreateInstance via the XrInstanceCreateInfo::enabledExtensionNames parameter as indicated in the extensions section.

To create an overlay session, an application must pass an XrSessionCreateInfoOverlayEXTX structure to CreateSession via the XrSessionCreateInfo structure’s next parameter.

An overlay application should not assume that the values returned to it by WaitFrame in predictedDisplayTime in XrFrameState will be the same as the values returned to the main application or even correlated.

Field Summary

Modifier and TypeField and Description
public static final String
XR_EXTX_OVERLAY_EXTENSION_NAME

The extension name.

public static final int
XR_EXTX_overlay_SPEC_VERSION

The extension specification version.

public static final int
XR_OVERLAY_MAIN_SESSION_ENABLED_COMPOSITION_LAYER_INFO_DEPTH_BIT_EXTX

XrOverlayMainSessionFlagBitsEXTX - XrOverlayMainSessionFlagBitsEXTX

public static final int
public static final int

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

XR_EXTX_OVERLAY_EXTENSION_NAMEback to summary
public static final String XR_EXTX_OVERLAY_EXTENSION_NAME

The extension name.

XR_EXTX_overlay_SPEC_VERSIONback to summary
public static final int XR_EXTX_overlay_SPEC_VERSION

The extension specification version.

XR_OVERLAY_MAIN_SESSION_ENABLED_COMPOSITION_LAYER_INFO_DEPTH_BIT_EXTXback to summary
public static final int XR_OVERLAY_MAIN_SESSION_ENABLED_COMPOSITION_LAYER_INFO_DEPTH_BIT_EXTX

XrOverlayMainSessionFlagBitsEXTX - XrOverlayMainSessionFlagBitsEXTX

XR_TYPE_EVENT_DATA_MAIN_SESSION_VISIBILITY_CHANGED_EXTXback to summary
public static final int XR_TYPE_EVENT_DATA_MAIN_SESSION_VISIBILITY_CHANGED_EXTX

Extends XrStructureType.

Enum values:
XR_TYPE_SESSION_CREATE_INFO_OVERLAY_EXTXback to summary
public static final int XR_TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX

Extends XrStructureType.

Enum values:

Constructor Detail

EXTXOverlayback to summary
private EXTXOverlay()