Package org.lwjgl.openxr

Class XrCompositionLayerProjection

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerProjection>

org.lwjgl.openxr.XrCompositionLayerProjection

All Implemented Interfaces:

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

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

Composition layer for projection.

Description

Note

Because a runtime may reproject the layer over time, a projection layer should specify an XrSpace in which to maximize stability of the layer content. For example, a projection layer containing world-locked content should use an XrSpace which is also world-locked, such as the LOCAL or STAGE reference spaces. In the case that the projection layer should be head-locked, such as a heads up display, the VIEW reference space would provide the highest quality layer reprojection.

Valid Usage (Implicit)

• type must be TYPE_COMPOSITION_LAYER_PROJECTION
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrCompositionLayerDepthTestVARJO, XrCompositionLayerReprojectionInfoMSFT, XrCompositionLayerReprojectionPlaneOverrideMSFT
• layerFlags must be 0 or a valid combination of XrCompositionLayerFlagBits values
• space must be a valid XrSpace handle
• views must be a pointer to an array of viewCount valid XrCompositionLayerProjectionView structures
• The viewCount parameter must be greater than 0

See Also

XrCompositionLayerBaseHeader, XrCompositionLayerProjectionView, XrSwapchainSubImage

Layout

 struct XrCompositionLayerProjection {
     XrStructureType type();
     void const * next();
     XrCompositionLayerFlags layerFlags();
     XrSpace space();
     uint32_t viewCount();
     XrCompositionLayerProjectionView const * views();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrCompositionLayerProjection.Buffer	An array of XrCompositionLayerProjection 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	LAYERFLAGS	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPACE	The struct member offsets.
static final int	TYPE	The struct member offsets.
static final int	VIEWCOUNT	The struct member offsets.
static final int	VIEWS	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
XrCompositionLayerProjection(ByteBuffer container)	Creates a XrCompositionLayerProjection instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerProjection	calloc()	Returns a new XrCompositionLayerProjection instance allocated with memCalloc.
static XrCompositionLayerProjection.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerProjection.Buffer instance allocated with memCalloc.
static XrCompositionLayerProjection.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerProjection.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerProjection	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerProjection instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerProjection	create()	Returns a new XrCompositionLayerProjection instance allocated with BufferUtils.
static XrCompositionLayerProjection.Buffer	create(int capacity)	Returns a new XrCompositionLayerProjection.Buffer instance allocated with BufferUtils.
static XrCompositionLayerProjection	create(long address)	Returns a new XrCompositionLayerProjection instance for the specified memory address.
static XrCompositionLayerProjection.Buffer	create(long address, int capacity)	Create a XrCompositionLayerProjection.Buffer instance at the specified memory.
static XrCompositionLayerProjection	create(XrCompositionLayerBaseHeader value)	Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerProjection.
static XrCompositionLayerProjection.Buffer	create(XrCompositionLayerBaseHeader.Buffer value)	Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerProjection.Buffer.
static @Nullable XrCompositionLayerProjection	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerProjection.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	layerFlags()	a bitmask of XrCompositionLayerFlagBits describing flags to apply to the layer.
XrCompositionLayerProjection	layerFlags(long value)	Sets the specified value to the layerFlags() field.
static XrCompositionLayerProjection	malloc()	Returns a new XrCompositionLayerProjection instance allocated with memAlloc.
static XrCompositionLayerProjection.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerProjection.Buffer instance allocated with memAlloc.
static XrCompositionLayerProjection.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerProjection.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerProjection	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerProjection instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerProjection	next(long value)	Sets the specified value to the next() field.
XrCompositionLayerProjection	next(XrCompositionLayerDepthTestVARJO value)	Prepends the specified XrCompositionLayerDepthTestVARJO value to the next chain.
XrCompositionLayerProjection	next(XrCompositionLayerReprojectionInfoMSFT value)	Prepends the specified XrCompositionLayerReprojectionInfoMSFT value to the next chain.
XrCompositionLayerProjection	next(XrCompositionLayerReprojectionPlaneOverrideMSFT value)	Prepends the specified XrCompositionLayerReprojectionPlaneOverrideMSFT value to the next chain.
static long	nlayerFlags(long struct)	Unsafe version of layerFlags().
static void	nlayerFlags(long struct, long value)	Unsafe version of layerFlags.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	nspace(long struct)	Unsafe version of space().
static void	nspace(long struct, XrSpace value)	Unsafe version of space.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static int	nviewCount(long struct)	Unsafe version of viewCount().
static void	nviewCount(long struct, int value)	Sets the specified value to the viewCount field of the specified struct.
static XrCompositionLayerProjectionView.Buffer	nviews(long struct)	Unsafe version of views().
static void	nviews(long struct, XrCompositionLayerProjectionView.Buffer value)	Unsafe version of views.
XrCompositionLayerProjection	set(int type, long next, long layerFlags, XrSpace space, XrCompositionLayerProjectionView.Buffer views)	Initializes this struct with the specified values.
XrCompositionLayerProjection	set(XrCompositionLayerProjection src)	Copies the specified struct data to this struct.
int	sizeof()
long	space()	the XrSpace in which the pose of each XrCompositionLayerProjectionView is evaluated over time by the compositor.
XrCompositionLayerProjection	space(XrSpace value)	Sets the specified value to the space() field.
int	type()	the XrStructureType of this structure.
XrCompositionLayerProjection	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerProjection	type$Default()	Sets the TYPE_COMPOSITION_LAYER_PROJECTION value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	viewCount()	the count of views in the views array.
XrCompositionLayerProjectionView.Buffer	views()	the array of type XrCompositionLayerProjectionView containing each projection layer view.
XrCompositionLayerProjection	views(XrCompositionLayerProjectionView.Buffer value)	Sets the address of the specified XrCompositionLayerProjectionView.Buffer to the views() 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.

LAYERFLAGS

public static final int LAYERFLAGS

The struct member offsets.

SPACE

public static final int SPACE

The struct member offsets.

VIEWCOUNT

public static final int VIEWCOUNT

The struct member offsets.

VIEWS

public static final int VIEWS

The struct member offsets.

Constructor Details

XrCompositionLayerProjection

public XrCompositionLayerProjection(ByteBuffer container)

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

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.

layerFlags

public long layerFlags()

a bitmask of XrCompositionLayerFlagBits describing flags to apply to the layer.

space

public long space()

the XrSpace in which the pose of each XrCompositionLayerProjectionView is evaluated over time by the compositor.

viewCount

public int viewCount()

the count of views in the views array. This must be equal to the number of view poses returned by LocateViews.

views

public XrCompositionLayerProjectionView.Buffer views()

the array of type XrCompositionLayerProjectionView containing each projection layer view.

type

public XrCompositionLayerProjection type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerProjection type$Default()

Sets the TYPE_COMPOSITION_LAYER_PROJECTION value to the type() field.

next

public XrCompositionLayerProjection next(long value)

Sets the specified value to the next() field.

next

public XrCompositionLayerProjection next(XrCompositionLayerDepthTestVARJO value)

Prepends the specified XrCompositionLayerDepthTestVARJO value to the next chain.

next

public XrCompositionLayerProjection next(XrCompositionLayerReprojectionInfoMSFT value)

Prepends the specified XrCompositionLayerReprojectionInfoMSFT value to the next chain.

next

public XrCompositionLayerProjection next(XrCompositionLayerReprojectionPlaneOverrideMSFT value)

Prepends the specified XrCompositionLayerReprojectionPlaneOverrideMSFT value to the next chain.

layerFlags

public XrCompositionLayerProjection layerFlags(long value)

Sets the specified value to the layerFlags() field.

space

public XrCompositionLayerProjection space(XrSpace value)

Sets the specified value to the space() field.

views

public XrCompositionLayerProjection views(XrCompositionLayerProjectionView.Buffer value)

Sets the address of the specified XrCompositionLayerProjectionView.Buffer to the views() field.

set

public XrCompositionLayerProjection set(int type,
 long next,
 long layerFlags,
 XrSpace space,
 XrCompositionLayerProjectionView.Buffer views)

Initializes this struct with the specified values.

set

public XrCompositionLayerProjection set(XrCompositionLayerProjection src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerProjection malloc()

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

calloc

public static XrCompositionLayerProjection calloc()

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

create

public static XrCompositionLayerProjection create()

Returns a new XrCompositionLayerProjection instance allocated with BufferUtils.

create

public static XrCompositionLayerProjection create(long address)

Returns a new XrCompositionLayerProjection instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerProjection createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerProjection create(XrCompositionLayerBaseHeader value)

Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerProjection.

malloc

public static XrCompositionLayerProjection.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerProjection.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerProjection.Buffer create(int capacity)

Returns a new XrCompositionLayerProjection.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerProjection.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerProjection.Buffer create(XrCompositionLayerBaseHeader.Buffer value)

Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerProjection.Buffer.

malloc

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

Returns a new XrCompositionLayerProjection instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlayerFlags

public static long nlayerFlags(long struct)

Unsafe version of layerFlags().

nspace

public static long nspace(long struct)

Unsafe version of space().

nviewCount

public static int nviewCount(long struct)

Unsafe version of viewCount().

nviews

public static XrCompositionLayerProjectionView.Buffer nviews(long struct)

Unsafe version of views().

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.

nlayerFlags

public static void nlayerFlags(long struct,
 long value)

Unsafe version of layerFlags.

nspace

public static void nspace(long struct,
 XrSpace value)

Unsafe version of space.

nviewCount

public static void nviewCount(long struct,
 int value)

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

nviews

public static void nviews(long struct,
 XrCompositionLayerProjectionView.Buffer value)

Unsafe version of views.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate