Package org.lwjgl.openxr

Class MSFTSecondaryViewConfiguration

java.lang.Object

org.lwjgl.openxr.MSFTSecondaryViewConfiguration

public final class MSFTSecondaryViewConfiguration
extends Object

The XR_MSFT_secondary_view_configuration extension.

This extension allows an application to enable support for one or more secondary view configurations. A secondary view configuration is a well-known set of views that the runtime can make active while a session is running. In a frame where a secondary view configuration is active, the application’s single frame loop should additionally render into those active secondary views, sharing the frame waiting logic and update loop with the primary view configuration for that running session.

A proper secondary view configuration support includes following steps:

• When calling CreateInstance, enable the XR_MSFT_secondary_view_configuration extension and the extension defines a concrete secondary view configuration type, for example, XR_MSFT_first_person_observer.
• Inspect supported secondary view configurations using the EnumerateViewConfigurations function.
• Enable supported secondary view configurations using the BeginSession function with an XrSecondaryViewConfigurationSessionBeginInfoMSFT chained extension structure.
• Inspect if an enabled secondary view configuration is activated by the system or the user using the WaitFrame function with an XrSecondaryViewConfigurationFrameStateMSFT chained extension structure.
• When a secondary view configuration is changed to active, get the latest view configuration properties using the GetViewConfigurationProperties and EnumerateViewConfigurationViews functions.
• Create the swapchain images for the active secondary view configuration using the CreateSwapchain function with an XrSecondaryViewConfigurationSwapchainCreateInfoMSFT chained extension structure using recommendedImageRectWidth and recommendedImageRectHeight in the corresponding XrViewConfigurationView structure returned from EnumerateViewConfigurationViews.
• Locate the secondary view configuration views using the LocateViews function with the active secondary view configuration type.
• Submit the composition layers using the swapchain images for an active secondary view configuration using the EndFrame function with the XrSecondaryViewConfigurationFrameEndInfoMSFT chained extension structure.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_SECONDARY_VIEW_CONFIGURATION_TYPE_NOT_ENABLED_MSFT	Extends XrResult.
static final String	XR_MSFT_SECONDARY_VIEW_CONFIGURATION_EXTENSION_NAME	The extension name.
static final int	XR_MSFT_secondary_view_configuration_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT	Extends XrStructureType.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

XR_MSFT_secondary_view_configuration_SPEC_VERSION

public static final int XR_MSFT_secondary_view_configuration_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_MSFT_SECONDARY_VIEW_CONFIGURATION_EXTENSION_NAME

public static final String XR_MSFT_SECONDARY_VIEW_CONFIGURATION_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT

public static final int XR_TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT

See Also:

• Constant Field Values

XR_TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT

public static final int XR_TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT

See Also:

• Constant Field Values

XR_TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT

public static final int XR_TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT

See Also:

• Constant Field Values

XR_TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT

public static final int XR_TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT

See Also:

• Constant Field Values

XR_TYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFT

public static final int XR_TYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT

See Also:

• Constant Field Values

XR_TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT

public static final int XR_TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFT
• TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT

See Also:

• Constant Field Values

XR_ERROR_SECONDARY_VIEW_CONFIGURATION_TYPE_NOT_ENABLED_MSFT

public static final int XR_ERROR_SECONDARY_VIEW_CONFIGURATION_TYPE_NOT_ENABLED_MSFT

Extends XrResult.

See Also:

• Constant Field Values