Package org.lwjgl.openxr

Class XrSecondaryViewConfigurationFrameStateMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSecondaryViewConfigurationFrameStateMSFT>

org.lwjgl.openxr.XrSecondaryViewConfigurationFrameStateMSFT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrSecondaryViewConfigurationFrameStateMSFT
extends org.lwjgl.system.Struct<XrSecondaryViewConfigurationFrameStateMSFT>
implements org.lwjgl.system.NativeResource

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

See Also

XrFrameState, XrSecondaryViewConfigurationStateMSFT

Layout

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.
static final int	VIEWCONFIGURATIONCOUNT	The struct member offsets.
static final int	VIEWCONFIGURATIONSTATES	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrSecondaryViewConfigurationFrameStateMSFT(ByteBuffer container)	Creates a XrSecondaryViewConfigurationFrameStateMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSecondaryViewConfigurationFrameStateMSFT	calloc()	Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance allocated with memCalloc.
static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	calloc(int capacity)	Returns a new XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance allocated with memCalloc.
static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSecondaryViewConfigurationFrameStateMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSecondaryViewConfigurationFrameStateMSFT	create()	Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance allocated with BufferUtils.
static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	create(int capacity)	Returns a new XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance allocated with BufferUtils.
static XrSecondaryViewConfigurationFrameStateMSFT	create(long address)	Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance for the specified memory address.
static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	create(long address, int capacity)	Create a XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance at the specified memory.
static @Nullable XrSecondaryViewConfigurationFrameStateMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSecondaryViewConfigurationFrameStateMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSecondaryViewConfigurationFrameStateMSFT	malloc()	Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance allocated with memAlloc.
static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	malloc(int capacity)	Returns a new XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance allocated with memAlloc.
static XrSecondaryViewConfigurationFrameStateMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSecondaryViewConfigurationFrameStateMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSecondaryViewConfigurationFrameStateMSFT	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static int	nviewConfigurationCount(long struct)	Unsafe version of viewConfigurationCount().
static void	nviewConfigurationCount(long struct, int value)	Sets the specified value to the viewConfigurationCount field of the specified struct.
static XrSecondaryViewConfigurationStateMSFT.Buffer	nviewConfigurationStates(long struct)	Unsafe version of viewConfigurationStates().
static void	nviewConfigurationStates(long struct, XrSecondaryViewConfigurationStateMSFT.Buffer value)	Unsafe version of viewConfigurationStates.
XrSecondaryViewConfigurationFrameStateMSFT	set(int type, long next, XrSecondaryViewConfigurationStateMSFT.Buffer viewConfigurationStates)	Initializes this struct with the specified values.
XrSecondaryViewConfigurationFrameStateMSFT	set(XrSecondaryViewConfigurationFrameStateMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSecondaryViewConfigurationFrameStateMSFT	type(int value)	Sets the specified value to the type() field.
XrSecondaryViewConfigurationFrameStateMSFT	type$Default()	Sets the TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	viewConfigurationCount()	the number of elements in viewConfigurationStates.
XrSecondaryViewConfigurationStateMSFT.Buffer	viewConfigurationStates()	an array of XrSecondaryViewConfigurationStateMSFT structures.
XrSecondaryViewConfigurationFrameStateMSFT	viewConfigurationStates(XrSecondaryViewConfigurationStateMSFT.Buffer value)	Sets the address of the specified XrSecondaryViewConfigurationStateMSFT.Buffer to the viewConfigurationStates() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

VIEWCONFIGURATIONCOUNT

public static final int VIEWCONFIGURATIONCOUNT

The struct member offsets.

VIEWCONFIGURATIONSTATES

public static final int VIEWCONFIGURATIONSTATES

The struct member offsets.

Constructor Details

XrSecondaryViewConfigurationFrameStateMSFT

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrSecondaryViewConfigurationFrameStateMSFT>

type

public int type()

the XrStructureType of this structure.

next

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.

viewConfigurationCount

public int viewConfigurationCount()

the number of elements in viewConfigurationStates.

viewConfigurationStates

public XrSecondaryViewConfigurationStateMSFT.Buffer viewConfigurationStates()

an array of XrSecondaryViewConfigurationStateMSFT structures.

type

public XrSecondaryViewConfigurationFrameStateMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSecondaryViewConfigurationFrameStateMSFT type$Default()

Sets the TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_STATE_MSFT value to the type() field.

next

public XrSecondaryViewConfigurationFrameStateMSFT next(long value)

Sets the specified value to the next() field.

viewConfigurationStates

public XrSecondaryViewConfigurationFrameStateMSFT viewConfigurationStates(XrSecondaryViewConfigurationStateMSFT.Buffer value)

Sets the address of the specified XrSecondaryViewConfigurationStateMSFT.Buffer to the viewConfigurationStates() field.

set

public XrSecondaryViewConfigurationFrameStateMSFT set(int type,
 long next,
 XrSecondaryViewConfigurationStateMSFT.Buffer viewConfigurationStates)

Initializes this struct with the specified values.

set

public XrSecondaryViewConfigurationFrameStateMSFT set(XrSecondaryViewConfigurationFrameStateMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSecondaryViewConfigurationFrameStateMSFT malloc()

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

calloc

public static XrSecondaryViewConfigurationFrameStateMSFT calloc()

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

create

public static XrSecondaryViewConfigurationFrameStateMSFT create()

Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance allocated with BufferUtils.

create

public static XrSecondaryViewConfigurationFrameStateMSFT create(long address)

Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSecondaryViewConfigurationFrameStateMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSecondaryViewConfigurationFrameStateMSFT.Buffer create(int capacity)

Returns a new XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSecondaryViewConfigurationFrameStateMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrSecondaryViewConfigurationFrameStateMSFT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrSecondaryViewConfigurationFrameStateMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrSecondaryViewConfigurationFrameStateMSFT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nviewConfigurationCount

public static int nviewConfigurationCount(long struct)

Unsafe version of viewConfigurationCount().

nviewConfigurationStates

public static XrSecondaryViewConfigurationStateMSFT.Buffer nviewConfigurationStates(long struct)

Unsafe version of viewConfigurationStates().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nviewConfigurationCount

public static void nviewConfigurationCount(long struct,
 int value)

Sets the specified value to the viewConfigurationCount field of the specified struct.

nviewConfigurationStates

public static void nviewConfigurationStates(long struct,
 XrSecondaryViewConfigurationStateMSFT.Buffer value)

Unsafe version of viewConfigurationStates.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate