Package org.lwjgl.openxr

Class XrSecondaryViewConfigurationSessionBeginInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSecondaryViewConfigurationSessionBeginInfoMSFT>

org.lwjgl.openxr.XrSecondaryViewConfigurationSessionBeginInfoMSFT

All Implemented Interfaces:

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

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

Describes an extension structure to BeginSession indicating supported view configuration types.

Description

If there are any duplicated view configuration types in the array of enabledViewConfigurationTypes, the runtime must return error ERROR_VALIDATION_FAILURE.

If there are any primary view configuration types in the array of enabledViewConfigurationTypes, the runtime must return error ERROR_VALIDATION_FAILURE.

If there are any secondary view configuration types not returned by EnumerateViewConfigurations in the array of enabledViewConfigurationTypes, the runtime must return error ERROR_VIEW_CONFIGURATION_TYPE_UNSUPPORTED.

Valid Usage (Implicit)

• The XR_MSFT_secondary_view_configuration extension must be enabled prior to using XrSecondaryViewConfigurationSessionBeginInfoMSFT
• type must be TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• enabledViewConfigurationTypes must be a pointer to an array of viewConfigurationCount valid XrViewConfigurationType values
• The viewConfigurationCount parameter must be greater than 0

See Also

XrSessionBeginInfo

Layout

 struct XrSecondaryViewConfigurationSessionBeginInfoMSFT {
     XrStructureType type();
     void const * next();
     uint32_t viewConfigurationCount();
     XrViewConfigurationType const * enabledViewConfigurationTypes();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer	An array of XrSecondaryViewConfigurationSessionBeginInfoMSFT 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	ENABLEDVIEWCONFIGURATIONTYPES	The struct member offsets.
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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSecondaryViewConfigurationSessionBeginInfoMSFT	calloc()	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT instance allocated with memCalloc.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer	calloc(int capacity)	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer instance allocated with memCalloc.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT	create()	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT instance allocated with BufferUtils.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer	create(int capacity)	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer instance allocated with BufferUtils.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT	create(long address)	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT instance for the specified memory address.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer	create(long address, int capacity)	Create a XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer instance at the specified memory.
static @Nullable XrSecondaryViewConfigurationSessionBeginInfoMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
IntBuffer	enabledViewConfigurationTypes()	an array of enabled secondary view configuration types that application supports.
XrSecondaryViewConfigurationSessionBeginInfoMSFT	enabledViewConfigurationTypes(IntBuffer value)	Sets the address of the specified IntBuffer to the enabledViewConfigurationTypes() field.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT	malloc()	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT instance allocated with memAlloc.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer	malloc(int capacity)	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer instance allocated with memAlloc.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSecondaryViewConfigurationSessionBeginInfoMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT instance allocated on the specified MemoryStack.
static IntBuffer	nenabledViewConfigurationTypes(long struct)	Unsafe version of enabledViewConfigurationTypes.
static void	nenabledViewConfigurationTypes(long struct, IntBuffer value)	Unsafe version of enabledViewConfigurationTypes.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSecondaryViewConfigurationSessionBeginInfoMSFT	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.
XrSecondaryViewConfigurationSessionBeginInfoMSFT	set(int type, long next, IntBuffer enabledViewConfigurationTypes)	Initializes this struct with the specified values.
XrSecondaryViewConfigurationSessionBeginInfoMSFT	set(XrSecondaryViewConfigurationSessionBeginInfoMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSecondaryViewConfigurationSessionBeginInfoMSFT	type(int value)	Sets the specified value to the type() field.
XrSecondaryViewConfigurationSessionBeginInfoMSFT	type$Default()	Sets the TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_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 enabledViewConfigurationTypes

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.

ENABLEDVIEWCONFIGURATIONTYPES

public static final int ENABLEDVIEWCONFIGURATIONTYPES

The struct member offsets.

Constructor Details

XrSecondaryViewConfigurationSessionBeginInfoMSFT

public XrSecondaryViewConfigurationSessionBeginInfoMSFT(ByteBuffer container)

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

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 enabledViewConfigurationTypes

enabledViewConfigurationTypes

public IntBuffer enabledViewConfigurationTypes()

an array of enabled secondary view configuration types that application supports.

type

public XrSecondaryViewConfigurationSessionBeginInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSecondaryViewConfigurationSessionBeginInfoMSFT type$Default()

Sets the TYPE_SECONDARY_VIEW_CONFIGURATION_SESSION_BEGIN_INFO_MSFT value to the type() field.

next

public XrSecondaryViewConfigurationSessionBeginInfoMSFT next(long value)

Sets the specified value to the next() field.

enabledViewConfigurationTypes

public XrSecondaryViewConfigurationSessionBeginInfoMSFT enabledViewConfigurationTypes(IntBuffer value)

Sets the address of the specified IntBuffer to the enabledViewConfigurationTypes() field.

set

public XrSecondaryViewConfigurationSessionBeginInfoMSFT set(int type,
 long next,
 IntBuffer enabledViewConfigurationTypes)

Initializes this struct with the specified values.

set

public XrSecondaryViewConfigurationSessionBeginInfoMSFT set(XrSecondaryViewConfigurationSessionBeginInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSecondaryViewConfigurationSessionBeginInfoMSFT malloc()

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

calloc

public static XrSecondaryViewConfigurationSessionBeginInfoMSFT calloc()

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

create

public static XrSecondaryViewConfigurationSessionBeginInfoMSFT create()

Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT instance allocated with BufferUtils.

create

public static XrSecondaryViewConfigurationSessionBeginInfoMSFT create(long address)

Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSecondaryViewConfigurationSessionBeginInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer create(int capacity)

Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSecondaryViewConfigurationSessionBeginInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrSecondaryViewConfigurationSessionBeginInfoMSFT.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().

nenabledViewConfigurationTypes

public static IntBuffer nenabledViewConfigurationTypes(long struct)

Unsafe version of enabledViewConfigurationTypes.

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.

nenabledViewConfigurationTypes

public static void nenabledViewConfigurationTypes(long struct,
 IntBuffer value)

Unsafe version of enabledViewConfigurationTypes.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate