Package org.lwjgl.openxr

Class XrSecondaryViewConfigurationStateMSFT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrSecondaryViewConfigurationStateMSFT>
org.lwjgl.openxr.XrSecondaryViewConfigurationStateMSFT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrSecondaryViewConfigurationStateMSFT extends org.lwjgl.system.Struct<XrSecondaryViewConfigurationStateMSFT> implements org.lwjgl.system.NativeResource
Returns the state of an enabled secondary view configuration.
Description

When a secondary view configuration becomes active, the application should render its secondary views as soon as possible, by getting their view transforms and FOV using LocateViews and then submitting composition layers to EndFrame through the XrSecondaryViewConfigurationFrameEndInfoMSFT extension structure. When a secondary view configuration changes from inactive to active, the runtime may change XrViewConfigurationView of the given view configuration such as the recommended image width or height. An application should query for latest XrViewConfigurationView through EnumerateViewConfigurationViews function for the secondary view configuration and consider recreating swapchain images if necessary. The runtime must not change the XrViewConfigurationView, including recommended image width and height of a secondary view configuration when active remains true until the secondary view configuration deactivated or the session has ended.

If necessary, the application can take longer than a frame duration to prepare by calling EndFrame without submitting layers for that secondary view configuration until ready. The runtime should delay the underlying scenario managed by the secondary view configuration until the application begins submitting frames with layers for that configuration. The active secondary view configuration composed output is undefined if the application stops submitting frames with layers for a secondary view configuration while active remains true.

When the runtime intends to conclude a secondary view configuration, for example when user stops video capture, the runtime makes the view configuration inactive by setting the corresponding active in the XrSecondaryViewConfigurationStateMSFT structure to false.

Valid Usage (Implicit)
See Also

XrFrameState, XrSecondaryViewConfigurationFrameStateMSFT

Layout


 struct XrSecondaryViewConfigurationStateMSFT {
     XrStructureType type();
     void * next();
     XrViewConfigurationType viewConfigurationType();
     XrBool32 active();
 }