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.
| Modifier and Type | Field 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 | XR_TYPE_EVENT_DATA_MAIN_SESSION_VISIBILITY_CHANGED_EXTX
Extends |
| public static final int | XR_TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX
Extends |
| Access | Constructor and Description |
|---|---|
| private |
| XR_EXTX_OVERLAY_EXTENSION_NAME | back to summary |
|---|---|
| public static final String XR_EXTX_OVERLAY_EXTENSION_NAME The extension name. | |
| XR_EXTX_overlay_SPEC_VERSION | back 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_EXTX | back 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_EXTX | back to summary |
|---|---|
| public static final int XR_TYPE_EVENT_DATA_MAIN_SESSION_VISIBILITY_CHANGED_EXTX Extends Enum values: | |
| XR_TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX | back to summary |
|---|---|
| public static final int XR_TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX Extends Enum values: | |
| EXTXOverlay | back to summary |
|---|---|
| private EXTXOverlay() | |