Package org.lwjgl.openxr

Class XrSecondaryViewConfigurationFrameEndInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSecondaryViewConfigurationFrameEndInfoMSFT>

org.lwjgl.openxr.XrSecondaryViewConfigurationFrameEndInfoMSFT

All Implemented Interfaces:

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

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

Submit an array of XrSecondaryViewConfigurationLayerInfoMSFT, one for each secondary view configuration.

Description

The view configuration type in each XrSecondaryViewConfigurationLayerInfoMSFT must be one of the view configurations enabled when calling BeginSession in XrSecondaryViewConfigurationSessionBeginInfoMSFT, or else the runtime must return error ERROR_SECONDARY_VIEW_CONFIGURATION_TYPE_NOT_ENABLED_MSFT.

The view configuration type in each XrSecondaryViewConfigurationLayerInfoMSFT must not be the primary view configuration in this session, or else the runtime must return error ERROR_LAYER_INVALID. The primary view configuration layers continue to be submitted through XrFrameEndInfo directly.

If the view configuration is not active, as indicated in XrSecondaryViewConfigurationFrameStateMSFT, the composition layers submitted to this view configuration may be ignored by the runtime. Applications should avoid rendering into secondary views when the view configuration is inactive.

Valid Usage (Implicit)

• The XR_MSFT_secondary_view_configuration extension must be enabled prior to using XrSecondaryViewConfigurationFrameEndInfoMSFT
• type must be TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• viewConfigurationLayersInfo must be a pointer to an array of viewConfigurationCount valid XrSecondaryViewConfigurationLayerInfoMSFT structures
• The viewConfigurationCount parameter must be greater than 0

See Also

XrSecondaryViewConfigurationLayerInfoMSFT, EndFrame

Layout

 struct XrSecondaryViewConfigurationFrameEndInfoMSFT {
     XrStructureType type();
     void const * next();
     uint32_t viewConfigurationCount();
     XrSecondaryViewConfigurationLayerInfoMSFT const * viewConfigurationLayersInfo();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSecondaryViewConfigurationFrameEndInfoMSFT.Buffer	An array of XrSecondaryViewConfigurationFrameEndInfoMSFT 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	VIEWCONFIGURATIONLAYERSINFO	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
XrSecondaryViewConfigurationFrameEndInfoMSFT(ByteBuffer container)	Creates a XrSecondaryViewConfigurationFrameEndInfoMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

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

VIEWCONFIGURATIONLAYERSINFO

public static final int VIEWCONFIGURATIONLAYERSINFO

The struct member offsets.

Constructor Details

XrSecondaryViewConfigurationFrameEndInfoMSFT

public XrSecondaryViewConfigurationFrameEndInfoMSFT(ByteBuffer container)

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

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 viewConfigurationLayersInfo.

viewConfigurationLayersInfo

public XrSecondaryViewConfigurationLayerInfoMSFT.Buffer viewConfigurationLayersInfo()

an array of XrSecondaryViewConfigurationLayerInfoMSFT, containing composition layers to be submitted for the specified active view configuration.

type

public XrSecondaryViewConfigurationFrameEndInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSecondaryViewConfigurationFrameEndInfoMSFT type$Default()

Sets the TYPE_SECONDARY_VIEW_CONFIGURATION_FRAME_END_INFO_MSFT value to the type() field.

next

public XrSecondaryViewConfigurationFrameEndInfoMSFT next(long value)

Sets the specified value to the next() field.

viewConfigurationLayersInfo

public XrSecondaryViewConfigurationFrameEndInfoMSFT viewConfigurationLayersInfo(XrSecondaryViewConfigurationLayerInfoMSFT.Buffer value)

Sets the address of the specified XrSecondaryViewConfigurationLayerInfoMSFT.Buffer to the viewConfigurationLayersInfo() field.

set

public XrSecondaryViewConfigurationFrameEndInfoMSFT set(int type,
 long next,
 XrSecondaryViewConfigurationLayerInfoMSFT.Buffer viewConfigurationLayersInfo)

Initializes this struct with the specified values.

set

public XrSecondaryViewConfigurationFrameEndInfoMSFT set(XrSecondaryViewConfigurationFrameEndInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSecondaryViewConfigurationFrameEndInfoMSFT malloc()

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

calloc

public static XrSecondaryViewConfigurationFrameEndInfoMSFT calloc()

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

create

public static XrSecondaryViewConfigurationFrameEndInfoMSFT create()

Returns a new XrSecondaryViewConfigurationFrameEndInfoMSFT instance allocated with BufferUtils.

create

public static XrSecondaryViewConfigurationFrameEndInfoMSFT create(long address)

Returns a new XrSecondaryViewConfigurationFrameEndInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSecondaryViewConfigurationFrameEndInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSecondaryViewConfigurationFrameEndInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSecondaryViewConfigurationFrameEndInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSecondaryViewConfigurationFrameEndInfoMSFT.Buffer create(int capacity)

Returns a new XrSecondaryViewConfigurationFrameEndInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSecondaryViewConfigurationFrameEndInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSecondaryViewConfigurationFrameEndInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nviewConfigurationLayersInfo

public static XrSecondaryViewConfigurationLayerInfoMSFT.Buffer nviewConfigurationLayersInfo(long struct)

Unsafe version of viewConfigurationLayersInfo().

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.

nviewConfigurationLayersInfo

public static void nviewConfigurationLayersInfo(long struct,
 XrSecondaryViewConfigurationLayerInfoMSFT.Buffer value)

Unsafe version of viewConfigurationLayersInfo.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate