Package org.lwjgl.openxr

Class MNDHeadless

java.lang.Object

org.lwjgl.openxr.MNDHeadless

public final class MNDHeadless
extends Object

The XR_MND_headless extension.

Some applications may wish to access XR interaction devices without presenting any image content on the display(s). This extension provides a mechanism for writing such an application using the OpenXR API. It modifies the specification in the following ways, without adding any new named entities.

• When this extension is enabled, an application may call CreateSession without an stext:XrGraphicsBinding* structure in its next chain. In this case, the runtime must create a "headless" session that does not interact with the display.
• In a headless session, the session state should proceed to SESSION_STATE_READY directly from SESSION_STATE_IDLE.
• In a headless session, the XrSessionBeginInfo::primaryViewConfigurationType must be ignored and may be 0.
• In a headless session, the session state proceeds to SESSION_STATE_SYNCHRONIZED, then SESSION_STATE_VISIBLE and SESSION_STATE_FOCUSED, after the call to BeginSession. The application does not need to call WaitFrame, BeginFrame, or EndFrame, unlike with non-headless sessions.
• In a headless session, EnumerateSwapchainFormats must return SUCCESS but enumerate 0 formats.
• WaitFrame must set XrFrameState::shouldRender to FALSE in a headless session. The VISIBLE and FOCUSED states are only used for their input-related semantics, not their rendering-related semantics, and these functions are permitted to allow minimal change between headless and non-headless code if desired.

Because WaitFrame is not required, an application using a headless session should sleep periodically to avoid consuming all available system resources in a busy-wait loop.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_MND_HEADLESS_EXTENSION_NAME	The extension name.
static final int	XR_MND_headless_SPEC_VERSION	The extension specification version.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_MND_headless_SPEC_VERSION

public static final int XR_MND_headless_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_MND_HEADLESS_EXTENSION_NAME

public static final String XR_MND_HEADLESS_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values