Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSecondaryViewConfigurationStateMSFT

extends Struct<XrSecondaryViewConfigurationStateMSFT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ACTIVE

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

public static final int
VIEWCONFIGURATIONTYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrSecondaryViewConfigurationStateMSFT(ByteBuffer container)

Creates a XrSecondaryViewConfigurationStateMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public boolean
active()

an XrBool32 returns whether the secondary view configuration is active and displaying frames to users.

public XrSecondaryViewConfigurationStateMSFT
active(boolean value)

Sets the specified value to the active field.

public static XrSecondaryViewConfigurationStateMSFT
calloc()

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated with memCalloc.

public static XrSecondaryViewConfigurationStateMSFT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated with memCalloc.

public static XrSecondaryViewConfigurationStateMSFT
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static XrSecondaryViewConfigurationStateMSFT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected XrSecondaryViewConfigurationStateMSFT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrSecondaryViewConfigurationStateMSFT
create()

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated with BufferUtils.

public static XrSecondaryViewConfigurationStateMSFT
create(long address)

Returns a new XrSecondaryViewConfigurationStateMSFT instance for the specified memory address.

public static XrSecondaryViewConfigurationStateMSFT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated with BufferUtils.

public static XrSecondaryViewConfigurationStateMSFT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a XrSecondaryViewConfigurationStateMSFT.Buffer instance at the specified memory.

public static XrSecondaryViewConfigurationStateMSFT
createSafe(long address)

Like create, but returns null if address is NULL.

public static XrSecondaryViewConfigurationStateMSFT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static XrSecondaryViewConfigurationStateMSFT
malloc()

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated with memAlloc.

public static XrSecondaryViewConfigurationStateMSFT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated with memAlloc.

public static XrSecondaryViewConfigurationStateMSFT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated on the specified MemoryStack.

public static XrSecondaryViewConfigurationStateMSFT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated on the specified MemoryStack.

public static int
nactive(long struct)

Unsafe version of active.

public static void
nactive(long struct, int value)

Unsafe version of active.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrSecondaryViewConfigurationStateMSFT
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nviewConfigurationType(long struct)

Unsafe version of viewConfigurationType.

public static void
nviewConfigurationType(long struct, int value)

Unsafe version of viewConfigurationType.

public XrSecondaryViewConfigurationStateMSFT
set(int type, long next, int viewConfigurationType, boolean active)

Initializes this struct with the specified values.

public XrSecondaryViewConfigurationStateMSFT

Returns:

this struct
set
(XrSecondaryViewConfigurationStateMSFT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
type()

the XrStructureType of this structure.

public XrSecondaryViewConfigurationStateMSFT
type(int value)

Sets the specified value to the type field.

public XrSecondaryViewConfigurationStateMSFT
public int
viewConfigurationType()

an XrViewConfigurationType that represents the returned state.

public XrSecondaryViewConfigurationStateMSFT
viewConfigurationType(int value)

Sets the specified value to the viewConfigurationType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ACTIVEback to summary
public static final int ACTIVE

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

VIEWCONFIGURATIONTYPEback to summary
public static final int VIEWCONFIGURATIONTYPE

The struct member offsets.

Constructor Detail

XrSecondaryViewConfigurationStateMSFTback to summary
protected XrSecondaryViewConfigurationStateMSFT(long address, ByteBuffer container)
XrSecondaryViewConfigurationStateMSFTback to summary
public XrSecondaryViewConfigurationStateMSFT(ByteBuffer container)

Creates a XrSecondaryViewConfigurationStateMSFT instance at the current position of the specified ByteBuffer container. 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

activeback to summary
public boolean active()

an XrBool32 returns whether the secondary view configuration is active and displaying frames to users.

Annotations
@NativeType:XrBool32
activeback to summary
public XrSecondaryViewConfigurationStateMSFT active(boolean value)

Sets the specified value to the active field.

callocback to summary
public static XrSecondaryViewConfigurationStateMSFT calloc()

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static XrSecondaryViewConfigurationStateMSFT.Buffer calloc(int capacity)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSecondaryViewConfigurationStateMSFT calloc(MemoryStack stack)

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrSecondaryViewConfigurationStateMSFT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrSecondaryViewConfigurationStateMSFT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrSecondaryViewConfigurationStateMSFT create()

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated with BufferUtils.

createback to summary
public static XrSecondaryViewConfigurationStateMSFT create(long address)

Returns a new XrSecondaryViewConfigurationStateMSFT instance for the specified memory address.

createback to summary
public static XrSecondaryViewConfigurationStateMSFT.Buffer create(int capacity)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static XrSecondaryViewConfigurationStateMSFT.Buffer create(long address, int capacity)

Create a XrSecondaryViewConfigurationStateMSFT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSecondaryViewConfigurationStateMSFT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrSecondaryViewConfigurationStateMSFT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrSecondaryViewConfigurationStateMSFT malloc()

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static XrSecondaryViewConfigurationStateMSFT.Buffer malloc(int capacity)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSecondaryViewConfigurationStateMSFT malloc(MemoryStack stack)

Returns a new XrSecondaryViewConfigurationStateMSFT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrSecondaryViewConfigurationStateMSFT.Buffer malloc(int capacity, MemoryStack stack)

Returns a new XrSecondaryViewConfigurationStateMSFT.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nactiveback to summary
public static int nactive(long struct)

Unsafe version of active.

nactiveback to summary
public static void nactive(long struct, int value)

Unsafe version of active.

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

Annotations
@NativeType:void *
nextback to summary
public XrSecondaryViewConfigurationStateMSFT next(long value)

Sets the specified value to the next field.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

nviewConfigurationTypeback to summary
public static int nviewConfigurationType(long struct)

Unsafe version of viewConfigurationType.

nviewConfigurationTypeback to summary
public static void nviewConfigurationType(long struct, int value)

Unsafe version of viewConfigurationType.

setback to summary
public XrSecondaryViewConfigurationStateMSFT set(int type, long next, int viewConfigurationType, boolean active)

Initializes this struct with the specified values.

setback to summary
public XrSecondaryViewConfigurationStateMSFT set(XrSecondaryViewConfigurationStateMSFT src)

Copies the specified struct data to this struct.

Parameters
src:XrSecondaryViewConfigurationStateMSFT

the source struct

Returns:XrSecondaryViewConfigurationStateMSFT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrSecondaryViewConfigurationStateMSFT type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrSecondaryViewConfigurationStateMSFT type$Default()

Sets the TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT value to the type field.

viewConfigurationTypeback to summary
public int viewConfigurationType()

an XrViewConfigurationType that represents the returned state.

Annotations
@NativeType:XrViewConfigurationType
viewConfigurationTypeback to summary
public XrSecondaryViewConfigurationStateMSFT viewConfigurationType(int value)

Sets the specified value to the viewConfigurationType field.

org.lwjgl.openxr back to summary

public Class XrSecondaryViewConfigurationStateMSFT.Buffer

extends StructBuffer<XrSecondaryViewConfigurationStateMSFT, XrSecondaryViewConfigurationStateMSFT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrSecondaryViewConfigurationStateMSFT structs.

Field Summary

Modifier and TypeField and Description
private static final XrSecondaryViewConfigurationStateMSFT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSecondaryViewConfigurationStateMSFT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

the value of the XrSecondaryViewConfigurationStateMSFT#active field.
active
()

public XrSecondaryViewConfigurationStateMSFT.Buffer
active(boolean value)

Sets the specified value to the XrSecondaryViewConfigurationStateMSFT#active field.

protected XrSecondaryViewConfigurationStateMSFT
public long

Returns:

the value of the XrSecondaryViewConfigurationStateMSFT#next field.
next
()

public XrSecondaryViewConfigurationStateMSFT.Buffer
next(long value)

Sets the specified value to the XrSecondaryViewConfigurationStateMSFT#next field.

protected XrSecondaryViewConfigurationStateMSFT.Buffer
public int

Returns:

the value of the XrSecondaryViewConfigurationStateMSFT#type field.
type
()

public XrSecondaryViewConfigurationStateMSFT.Buffer
type(int value)

Sets the specified value to the XrSecondaryViewConfigurationStateMSFT#type field.

public XrSecondaryViewConfigurationStateMSFT.Buffer
public int
public XrSecondaryViewConfigurationStateMSFT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSecondaryViewConfigurationStateMSFT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSecondaryViewConfigurationStateMSFT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrSecondaryViewConfigurationStateMSFT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

activeback to summary
public boolean active()
Returns:boolean

the value of the XrSecondaryViewConfigurationStateMSFT#active field.

Annotations
@NativeType:XrBool32
activeback to summary
public XrSecondaryViewConfigurationStateMSFT.Buffer active(boolean value)

Sets the specified value to the XrSecondaryViewConfigurationStateMSFT#active field.

getElementFactoryback to summary
protected XrSecondaryViewConfigurationStateMSFT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrSecondaryViewConfigurationStateMSFT#next field.

Annotations
@NativeType:void *
nextback to summary
public XrSecondaryViewConfigurationStateMSFT.Buffer next(long value)

Sets the specified value to the XrSecondaryViewConfigurationStateMSFT#next field.

selfback to summary
protected XrSecondaryViewConfigurationStateMSFT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrSecondaryViewConfigurationStateMSFT#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrSecondaryViewConfigurationStateMSFT.Buffer type(int value)

Sets the specified value to the XrSecondaryViewConfigurationStateMSFT#type field.

type$Defaultback to summary
public XrSecondaryViewConfigurationStateMSFT.Buffer type$Default()

Sets the TYPE_SECONDARY_VIEW_CONFIGURATION_STATE_MSFT value to the XrSecondaryViewConfigurationStateMSFT#type field.

viewConfigurationTypeback to summary
public int viewConfigurationType()
Returns:int

the value of the XrSecondaryViewConfigurationStateMSFT#viewConfigurationType field.

Annotations
@NativeType:XrViewConfigurationType
viewConfigurationTypeback to summary
public XrSecondaryViewConfigurationStateMSFT.Buffer viewConfigurationType(int value)

Sets the specified value to the XrSecondaryViewConfigurationStateMSFT#viewConfigurationType field.