Class XrSecondaryViewConfigurationStateMSFT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrSecondaryViewConfigurationStateMSFT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrSecondaryViewConfigurationStateMSFT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceReturns 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
LocateViewsand then submitting composition layers toEndFramethrough theXrSecondaryViewConfigurationFrameEndInfoMSFTextension structure. When a secondary view configuration changes from inactive to active, the runtime may changeXrViewConfigurationViewof the given view configuration such as the recommended image width or height. An application should query for latestXrViewConfigurationViewthroughEnumerateViewConfigurationViewsfunction for the secondary view configuration and consider recreating swapchain images if necessary. The runtime must not change theXrViewConfigurationView, including recommended image width and height of a secondary view configuration whenactiveremains 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
EndFramewithout 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 whileactiveremains 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
activein theXrSecondaryViewConfigurationStateMSFTstructure to false.Valid Usage (Implicit)
- The
XR_MSFT_secondary_view_configurationextension must be enabled prior to usingXrSecondaryViewConfigurationStateMSFT typemust beTYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFTnextmust beNULLor a valid pointer to the next structure in a structure chainviewConfigurationTypemust be a validXrViewConfigurationTypevalue
See Also
XrFrameState,XrSecondaryViewConfigurationFrameStateMSFTLayout
struct XrSecondaryViewConfigurationStateMSFT { XrStructureTypetype(); void *next(); XrViewConfigurationTypeviewConfigurationType(); XrBool32active(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrSecondaryViewConfigurationStateMSFT.BufferAn array ofXrSecondaryViewConfigurationStateMSFTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intACTIVEThe struct member offsets.static intALIGNOFThe struct alignment in bytes.static intNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPE
VIEWCONFIGURATIONTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrSecondaryViewConfigurationStateMSFT(java.nio.ByteBuffer container)Creates aXrSecondaryViewConfigurationStateMSFTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanactive()anXrBool32returns whether the secondary view configuration is active and displaying frames to users.XrSecondaryViewConfigurationStateMSFTactive(boolean value)Sets the specified value to theactive()field.static XrSecondaryViewConfigurationStateMSFTcalloc()Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated withmemCalloc.static XrSecondaryViewConfigurationStateMSFT.Buffercalloc(int capacity)Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated withmemCalloc.static XrSecondaryViewConfigurationStateMSFT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSecondaryViewConfigurationStateMSFTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSecondaryViewConfigurationStateMSFTcreate()Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated withBufferUtils.static XrSecondaryViewConfigurationStateMSFT.Buffercreate(int capacity)Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated withBufferUtils.static XrSecondaryViewConfigurationStateMSFTcreate(long address)Returns a newXrSecondaryViewConfigurationStateMSFTinstance for the specified memory address.static XrSecondaryViewConfigurationStateMSFT.Buffercreate(long address, int capacity)Create aXrSecondaryViewConfigurationStateMSFT.Bufferinstance at the specified memory.static XrSecondaryViewConfigurationStateMSFTcreateSafe(long address)static XrSecondaryViewConfigurationStateMSFT.BuffercreateSafe(long address, int capacity)static XrSecondaryViewConfigurationStateMSFTmalloc()Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated withmemAlloc.static XrSecondaryViewConfigurationStateMSFT.Buffermalloc(int capacity)Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated withmemAlloc.static XrSecondaryViewConfigurationStateMSFT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated on the specifiedMemoryStack.static XrSecondaryViewConfigurationStateMSFTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated on the specifiedMemoryStack.static intnactive(long struct)Unsafe version ofactive().static voidnactive(long struct, int value)Unsafe version ofactive.longnext()NULLor a pointer to the next structure in a structure chain.XrSecondaryViewConfigurationStateMSFTnext(long value)Sets the specified value to thenext()field.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.static intnviewConfigurationType(long struct)Unsafe version ofviewConfigurationType().static voidnviewConfigurationType(long struct, int value)Unsafe version ofviewConfigurationType.XrSecondaryViewConfigurationStateMSFTset(int type, long next, int viewConfigurationType, boolean active)Initializes this struct with the specified values.XrSecondaryViewConfigurationStateMSFTset(XrSecondaryViewConfigurationStateMSFT src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrSecondaryViewConfigurationStateMSFTtype(int value)Sets the specified value to thetype()field.XrSecondaryViewConfigurationStateMSFTtype$Default()Sets theTYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFTvalue to thetype()field.intviewConfigurationType()anXrViewConfigurationTypethat represents the returned state.XrSecondaryViewConfigurationStateMSFTviewConfigurationType(int value)Sets the specified value to theviewConfigurationType()field.
-
-
-
Constructor Detail
-
XrSecondaryViewConfigurationStateMSFT
public XrSecondaryViewConfigurationStateMSFT(java.nio.ByteBuffer container)
Creates aXrSecondaryViewConfigurationStateMSFTinstance at the current position of the specifiedByteBuffercontainer. Changes to the buffer's content will be visible to the struct instance and vice versa.The created instance holds a strong reference to the container object.
-
-
Method Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.
-
viewConfigurationType
public int viewConfigurationType()
anXrViewConfigurationTypethat represents the returned state.
-
active
public boolean active()
anXrBool32returns whether the secondary view configuration is active and displaying frames to users.
-
type
public XrSecondaryViewConfigurationStateMSFT type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrSecondaryViewConfigurationStateMSFT type$Default()
Sets theTYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFTvalue to thetype()field.
-
next
public XrSecondaryViewConfigurationStateMSFT next(long value)
Sets the specified value to thenext()field.
-
viewConfigurationType
public XrSecondaryViewConfigurationStateMSFT viewConfigurationType(int value)
Sets the specified value to theviewConfigurationType()field.
-
active
public XrSecondaryViewConfigurationStateMSFT active(boolean value)
Sets the specified value to theactive()field.
-
set
public XrSecondaryViewConfigurationStateMSFT set(int type, long next, int viewConfigurationType, boolean active)
Initializes this struct with the specified values.
-
set
public XrSecondaryViewConfigurationStateMSFT set(XrSecondaryViewConfigurationStateMSFT src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrSecondaryViewConfigurationStateMSFT malloc()
Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrSecondaryViewConfigurationStateMSFT calloc()
Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrSecondaryViewConfigurationStateMSFT create()
Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated withBufferUtils.
-
create
public static XrSecondaryViewConfigurationStateMSFT create(long address)
Returns a newXrSecondaryViewConfigurationStateMSFTinstance for the specified memory address.
-
createSafe
@Nullable public static XrSecondaryViewConfigurationStateMSFT createSafe(long address)
-
malloc
public static XrSecondaryViewConfigurationStateMSFT.Buffer malloc(int capacity)
Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrSecondaryViewConfigurationStateMSFT.Buffer calloc(int capacity)
Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrSecondaryViewConfigurationStateMSFT.Buffer create(int capacity)
Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrSecondaryViewConfigurationStateMSFT.Buffer create(long address, int capacity)
Create aXrSecondaryViewConfigurationStateMSFT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrSecondaryViewConfigurationStateMSFT.Buffer createSafe(long address, int capacity)
-
malloc
public static XrSecondaryViewConfigurationStateMSFT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrSecondaryViewConfigurationStateMSFT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSecondaryViewConfigurationStateMSFTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrSecondaryViewConfigurationStateMSFT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrSecondaryViewConfigurationStateMSFT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrSecondaryViewConfigurationStateMSFT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
nviewConfigurationType
public static int nviewConfigurationType(long struct)
Unsafe version ofviewConfigurationType().
-
nactive
public static int nactive(long struct)
Unsafe version ofactive().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nviewConfigurationType
public static void nviewConfigurationType(long struct, int value)Unsafe version ofviewConfigurationType.
-
nactive
public static void nactive(long struct, int value)Unsafe version ofactive.
-
-