LWJGL 3.3.3 · org.lwjgl.openxr.XrSecondaryViewConfigurationFrameStateMSFT

Extension structure to xrWaitFrame to return a list of secondary view configuration states.

Description

The array size viewConfigurationCount in the XrSecondaryViewConfigurationFrameStateMSFT structure must be the same as the array size enabled through XrSecondaryViewConfigurationSessionBeginInfoMSFT when calling BeginSession earlier, otherwise the runtime must return error ERROR_VALIDATION_FAILURE.

Valid Usage (Implicit)

The XR_MSFT_secondary_view_configuration extension must be enabled prior to using XrSecondaryViewConfigurationFrameStateMSFT
type must be TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT
next must be NULL or a valid pointer to the next structure in a structure chain
viewConfigurationStates must be a pointer to an array of viewConfigurationCount XrSecondaryViewConfigurationStateMSFT structures
The viewConfigurationCount parameter must be greater than 0

Layout


struct XrSecondaryViewConfigurationFrameStateMSFT {
    XrStructureType type;
    void * next;
    uint32_t viewConfigurationCount;
    XrSecondaryViewConfigurationStateMSFT * viewConfigurationStates;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrSecondaryViewConfigurationFrameStateMSFT.Buffer An array of `XrSecondaryViewConfigurationFrameStateMSFT` structs.

Field Summary

Modifier and Type	Field and Description
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	VIEWCONFIGURATIONCOUNT The struct member offsets.
public static final int	VIEWCONFIGURATIONSTATES The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrSecondaryViewConfigurationFrameStateMSFT(long address, ByteBuffer container)
public	XrSecondaryViewConfigurationFrameStateMSFT(ByteBuffer container) Creates a `XrSecondaryViewConfigurationFrameStateMSFT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrSecondaryViewConfigurationFrameStateMSFT	calloc() Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated with `memCalloc`.
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance allocated with `memCalloc`.
public static XrSecondaryViewConfigurationFrameStateMSFT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrSecondaryViewConfigurationFrameStateMSFT	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 XrSecondaryViewConfigurationFrameStateMSFT	create() Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated with `BufferUtils`.
public static XrSecondaryViewConfigurationFrameStateMSFT	create(long address) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance for the specified memory address.
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	create(int the buffer capacity capacity) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance allocated with `BufferUtils`.
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance at the specified memory.
public static XrSecondaryViewConfigurationFrameStateMSFT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSecondaryViewConfigurationFrameStateMSFT	malloc() Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated with `memAlloc`.
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance allocated with `memAlloc`.
public static XrSecondaryViewConfigurationFrameStateMSFT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated on the specified `MemoryStack`.
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance allocated on the specified `MemoryStack`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrSecondaryViewConfigurationFrameStateMSFT	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	nviewConfigurationCount(long struct) Unsafe version of `viewConfigurationCount`.
public static void	nviewConfigurationCount(long struct, int value) Sets the specified value to the `viewConfigurationCount` field of the specified `struct`.
public static XrSecondaryViewConfigurationStateMSFT.Buffer	nviewConfigurationStates(long struct) Unsafe version of `viewConfigurationStates`.
public static void	nviewConfigurationStates(long struct, XrSecondaryViewConfigurationStateMSFT.Buffer value) Unsafe version of `viewConfigurationStates`.
public XrSecondaryViewConfigurationFrameStateMSFT	set(int type, long next, XrSecondaryViewConfigurationStateMSFT.Buffer viewConfigurationStates) Initializes this struct with the specified values.
public XrSecondaryViewConfigurationFrameStateMSFT	Returns: this struct set(XrSecondaryViewConfigurationFrameStateMSFT 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 XrSecondaryViewConfigurationFrameStateMSFT	type(int value) Sets the specified value to the `type` field.
public XrSecondaryViewConfigurationFrameStateMSFT	type$Default() Sets the `TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT` value to the `type` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.
public int	viewConfigurationCount() the number of elements in `viewConfigurationStates`.
public XrSecondaryViewConfigurationStateMSFT.Buffer	viewConfigurationStates() an array of `XrSecondaryViewConfigurationStateMSFT` structures.
public XrSecondaryViewConfigurationFrameStateMSFT	viewConfigurationStates(XrSecondaryViewConfigurationStateMSFT.Buffer value) Sets the address of the specified `XrSecondaryViewConfigurationStateMSFT.Buffer` to the `viewConfigurationStates` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

NEXT	back to summary
public static final int NEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

VIEWCONFIGURATIONCOUNT	back to summary
public static final int VIEWCONFIGURATIONCOUNT The struct member offsets.

VIEWCONFIGURATIONSTATES	back to summary
public static final int VIEWCONFIGURATIONSTATES The struct member offsets.

Constructor Detail

XrSecondaryViewConfigurationFrameStateMSFT	back to summary
protected XrSecondaryViewConfigurationFrameStateMSFT(long address, ByteBuffer container)

XrSecondaryViewConfigurationFrameStateMSFT back to summary

XrSecondaryViewConfigurationFrameStateMSFT	back to summary
public XrSecondaryViewConfigurationFrameStateMSFT(ByteBuffer container) Creates a `XrSecondaryViewConfigurationFrameStateMSFT` 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.

public XrSecondaryViewConfigurationFrameStateMSFT(ByteBuffer container)

Creates a XrSecondaryViewConfigurationFrameStateMSFT 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

calloc	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT calloc() Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer calloc(int capacity) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT calloc(MemoryStack stack) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrSecondaryViewConfigurationFrameStateMSFT calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.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

public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrSecondaryViewConfigurationFrameStateMSFT.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

create back to summary

create	back to summary
protected XrSecondaryViewConfigurationFrameStateMSFT 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

protected XrSecondaryViewConfigurationFrameStateMSFT 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

create	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT create() Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated with `BufferUtils`.

create	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT create(long address) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance for the specified memory address.

create back to summary

create	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer create(int capacity) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer create(int capacity)

Returns a new XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer create(long address, int capacity) Create a `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer create(long address, int capacity)

Create a XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrSecondaryViewConfigurationFrameStateMSFT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT malloc() Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer malloc(int capacity) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT malloc(MemoryStack stack) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSecondaryViewConfigurationFrameStateMSFT malloc(MemoryStack stack)

Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSecondaryViewConfigurationFrameStateMSFT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

next back to summary

next	back 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 *

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 *

next	back to summary
public XrSecondaryViewConfigurationFrameStateMSFT next(long value) Sets the specified value to the `next` field.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

nviewConfigurationCount	back to summary
public static int nviewConfigurationCount(long struct) Unsafe version of `viewConfigurationCount`.

nviewConfigurationCount	back to summary
public static void nviewConfigurationCount(long struct, int value) Sets the specified value to the `viewConfigurationCount` field of the specified `struct`.

nviewConfigurationStates	back to summary
public static XrSecondaryViewConfigurationStateMSFT.Buffer nviewConfigurationStates(long struct) Unsafe version of `viewConfigurationStates`.

nviewConfigurationStates	back to summary
public static void nviewConfigurationStates(long struct, XrSecondaryViewConfigurationStateMSFT.Buffer value) Unsafe version of `viewConfigurationStates`.

set	back to summary
public XrSecondaryViewConfigurationFrameStateMSFT set(int type, long next, XrSecondaryViewConfigurationStateMSFT.Buffer viewConfigurationStates) Initializes this struct with the specified values.

set	back to summary
public XrSecondaryViewConfigurationFrameStateMSFT set(XrSecondaryViewConfigurationFrameStateMSFT src) Copies the specified struct data to this struct. Parameters src:XrSecondaryViewConfigurationFrameStateMSFT the source struct Returns:XrSecondaryViewConfigurationFrameStateMSFT this struct

set

back to summary

public XrSecondaryViewConfigurationFrameStateMSFT set(XrSecondaryViewConfigurationFrameStateMSFT src)

Copies the specified struct data to this struct.

Parameters

src:XrSecondaryViewConfigurationFrameStateMSFT: the source struct

Returns:XrSecondaryViewConfigurationFrameStateMSFT

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

type back to summary

type	back to summary
public int type() the `XrStructureType` of this structure. Annotations @NativeType:XrStructureType

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrSecondaryViewConfigurationFrameStateMSFT type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrSecondaryViewConfigurationFrameStateMSFT type$Default() Sets the `TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT` value to the `type` field.

validate back to summary

validate	back to summary
public static void validate(long struct) Validates pointer members that should not be `NULL`. Parameters struct:long the struct to validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

viewConfigurationCount back to summary

viewConfigurationCount	back to summary
public int viewConfigurationCount() the number of elements in `viewConfigurationStates`. Annotations @NativeType:uint32_t

public int viewConfigurationCount()

the number of elements in viewConfigurationStates.

Annotations

@NativeType:uint32_t

viewConfigurationStates back to summary

viewConfigurationStates	back to summary
public XrSecondaryViewConfigurationStateMSFT.Buffer viewConfigurationStates() an array of `XrSecondaryViewConfigurationStateMSFT` structures. Annotations @NativeType:XrSecondaryViewConfigurationStateMSFT *

public XrSecondaryViewConfigurationStateMSFT.Buffer viewConfigurationStates()

an array of XrSecondaryViewConfigurationStateMSFT structures.

Annotations

@NativeType:XrSecondaryViewConfigurationStateMSFT *

viewConfigurationStates	back to summary
public XrSecondaryViewConfigurationFrameStateMSFT viewConfigurationStates(XrSecondaryViewConfigurationStateMSFT.Buffer value) Sets the address of the specified `XrSecondaryViewConfigurationStateMSFT.Buffer` to the `viewConfigurationStates` field.

Modifier and Type	Method and Description
protected XrSecondaryViewConfigurationFrameStateMSFT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `XrSecondaryViewConfigurationFrameStateMSFT#next` field. next()
public XrSecondaryViewConfigurationFrameStateMSFT.Buffer	next(long value) Sets the specified value to the `XrSecondaryViewConfigurationFrameStateMSFT#next` field.
protected XrSecondaryViewConfigurationFrameStateMSFT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrSecondaryViewConfigurationFrameStateMSFT#type` field. type()
public XrSecondaryViewConfigurationFrameStateMSFT.Buffer	type(int value) Sets the specified value to the `XrSecondaryViewConfigurationFrameStateMSFT#type` field.
public XrSecondaryViewConfigurationFrameStateMSFT.Buffer	type$Default() Sets the `TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT` value to the `XrSecondaryViewConfigurationFrameStateMSFT#type` field.
public int	Returns: the value of the `XrSecondaryViewConfigurationFrameStateMSFT#viewConfigurationCount` field. viewConfigurationCount()
public XrSecondaryViewConfigurationStateMSFT.Buffer	Returns: a `XrSecondaryViewConfigurationStateMSFT.Buffer` view of the struct array pointed to by the `XrSecondaryViewConfigurationFrameStateMSFT#viewConfigurationStates` field. viewConfigurationStates()
public XrSecondaryViewConfigurationFrameStateMSFT.Buffer	viewConfigurationStates(XrSecondaryViewConfigurationStateMSFT.Buffer value) Sets the address of the specified `XrSecondaryViewConfigurationStateMSFT.Buffer` to the `XrSecondaryViewConfigurationFrameStateMSFT#viewConfigurationStates` field.

public Class XrSecondaryViewConfigurationFrameStateMSFT

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrSecondaryViewConfigurationFrameStateMSFT.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrSecondaryViewConfigurationFrameStateMSFT.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)