Package org.lwjgl.openxr

Class XrSecondaryViewConfigurationSwapchainCreateInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSecondaryViewConfigurationSwapchainCreateInfoMSFT>

org.lwjgl.openxr.XrSecondaryViewConfigurationSwapchainCreateInfoMSFT

All Implemented Interfaces:

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

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

Hint to runtime that the created swapchain image will be used for given secondary view configuration.

Description

If this structure is not present in the XrSwapchainCreateInfo next chain when calling CreateSwapchain, the runtime should optimize the created swapchain for the primary view configuration of the session.

If the application submits a swapchain image created with one view configuration type to a composition layer for another view configuration, the runtime may need to copy the resource across view configurations. However, the runtime must correctly compose the image regardless which view configuration type was hinted when swapchain image was created.

Valid Usage (Implicit)

• The XR_MSFT_secondary_view_configuration extension must be enabled prior to using XrSecondaryViewConfigurationSwapchainCreateInfoMSFT
• type must be TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• viewConfigurationType must be a valid XrViewConfigurationType value

See Also

XrSwapchainCreateInfo

Layout

 struct XrSecondaryViewConfigurationSwapchainCreateInfoMSFT {
     XrStructureType type();
     void const * next();
     XrViewConfigurationType viewConfigurationType();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

VIEWCONFIGURATIONTYPE

public static final int VIEWCONFIGURATIONTYPE

The struct member offsets.

Constructor Details

XrSecondaryViewConfigurationSwapchainCreateInfoMSFT

public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT(ByteBuffer container)

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

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.

viewConfigurationType

public int viewConfigurationType()

the secondary view configuration type the application is intending to use this swapchain for.

type

public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT type$Default()

Sets the TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT value to the type() field.

next

public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT next(long value)

Sets the specified value to the next() field.

viewConfigurationType

public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT viewConfigurationType(int value)

Sets the specified value to the viewConfigurationType() field.

set

public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT set(int type,
 long next,
 int viewConfigurationType)

Initializes this struct with the specified values.

set

public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT set(XrSecondaryViewConfigurationSwapchainCreateInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT malloc()

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

calloc

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT calloc()

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

create

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT create()

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT instance allocated with BufferUtils.

create

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT create(long address)

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSecondaryViewConfigurationSwapchainCreateInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer create(int capacity)

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nviewConfigurationType

public static int nviewConfigurationType(long struct)

Unsafe version of viewConfigurationType().

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.

nviewConfigurationType

public static void nviewConfigurationType(long struct,
 int value)

Unsafe version of viewConfigurationType.