LWJGL 3.3.3 · org.lwjgl.openxr.XrSecondaryViewConfigurationSwapchainCreateInfoMSFT

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

Layout


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

Nested and Inner Type Summary

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

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

Constructor Summary

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

Method Summary

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

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

Constructor Detail

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

XrSecondaryViewConfigurationSwapchainCreateInfoMSFT back to summary

XrSecondaryViewConfigurationSwapchainCreateInfoMSFT	back to summary
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.

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 Detail

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

calloc back to summary

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

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer calloc(int capacity)

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT calloc(MemoryStack stack) Returns a new `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT calloc(MemoryStack stack)

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT 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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT 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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT 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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT create() Returns a new `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT` instance allocated with `BufferUtils`.

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

create back to summary

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

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer create(int capacity)

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

malloc back to summary

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

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer malloc(int capacity)

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT malloc(MemoryStack stack) Returns a new `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSecondaryViewConfigurationSwapchainCreateInfoMSFT malloc(MemoryStack stack)

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT 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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

Returns a new XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.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 const *

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 const *

next	back to summary
public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT 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`.

nviewConfigurationType	back to summary
public static int nviewConfigurationType(long struct) Unsafe version of `viewConfigurationType`.

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

set	back to summary
public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT set(int type, long next, int viewConfigurationType) Initializes this struct with the specified values.

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

set

back to summary

public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT set(XrSecondaryViewConfigurationSwapchainCreateInfoMSFT src)

Copies the specified struct data to this struct.

Parameters

src:XrSecondaryViewConfigurationSwapchainCreateInfoMSFT: the source struct

Returns:XrSecondaryViewConfigurationSwapchainCreateInfoMSFT

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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT type$Default() Sets the `TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT` value to the `type` field.

viewConfigurationType	back to summary
public int viewConfigurationType() the secondary view configuration type the application is intending to use this swapchain for. Annotations @NativeType:XrViewConfigurationType

viewConfigurationType

back to summary

public int viewConfigurationType()

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

Annotations

@NativeType:XrViewConfigurationType

viewConfigurationType	back to summary
public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT viewConfigurationType(int value) Sets the specified value to the `viewConfigurationType` field.

Modifier and Type	Method and Description
protected XrSecondaryViewConfigurationSwapchainCreateInfoMSFT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT#next` field. next()
public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer	next(long value) Sets the specified value to the `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT#next` field.
protected XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT#type` field. type()
public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer	type(int value) Sets the specified value to the `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT#type` field.
public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer	type$Default() Sets the `TYPE_SECONDARY_VIEW_CONFIGURATION_SWAPCHAIN_CREATE_INFO_MSFT` value to the `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT#type` field.
public int	Returns: the value of the `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT#viewConfigurationType` field. viewConfigurationType()
public XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer	viewConfigurationType(int value) Sets the specified value to the `XrSecondaryViewConfigurationSwapchainCreateInfoMSFT#viewConfigurationType` field.

public Class XrSecondaryViewConfigurationSwapchainCreateInfoMSFT

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 XrSecondaryViewConfigurationSwapchainCreateInfoMSFT.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

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