Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrCompositionLayerProjection

extends Struct<XrCompositionLayerProjection>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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)
See Also

XrCompositionLayerBaseHeader, XrCompositionLayerProjectionView, XrSwapchainSubImage

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
LAYERFLAGS

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SPACE

The struct member offsets.

public static final int
TYPE

The struct member offsets.

public static final int
VIEWCOUNT

The struct member offsets.

public static final int
VIEWS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrCompositionLayerProjection(long address, ByteBuffer container)

public
XrCompositionLayerProjection(ByteBuffer container)

Creates a XrCompositionLayerProjection instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrCompositionLayerProjection
calloc()

Returns a new XrCompositionLayerProjection instance allocated with memCalloc.

public static XrCompositionLayerProjection.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrCompositionLayerProjection.Buffer instance allocated with memCalloc.

public static XrCompositionLayerProjection
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrCompositionLayerProjection.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected XrCompositionLayerProjection
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 XrCompositionLayerProjection
create()

Returns a new XrCompositionLayerProjection instance allocated with BufferUtils.

public static XrCompositionLayerProjection
create(long address)

Returns a new XrCompositionLayerProjection instance for the specified memory address.

public static XrCompositionLayerProjection
create(XrCompositionLayerBaseHeader value)

Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerProjection.

public static XrCompositionLayerProjection.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrCompositionLayerProjection.Buffer instance allocated with BufferUtils.

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

Create a XrCompositionLayerProjection.Buffer instance at the specified memory.

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

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

public static XrCompositionLayerProjection
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
layerFlags()

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

public XrCompositionLayerProjection
layerFlags(long value)

Sets the specified value to the layerFlags field.

public static XrCompositionLayerProjection
malloc()

Returns a new XrCompositionLayerProjection instance allocated with memAlloc.

public static XrCompositionLayerProjection.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrCompositionLayerProjection.Buffer instance allocated with memAlloc.

public static XrCompositionLayerProjection
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrCompositionLayerProjection instance allocated on the specified MemoryStack.

public static XrCompositionLayerProjection.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrCompositionLayerProjection
next(long value)

Sets the specified value to the next field.

public XrCompositionLayerProjection
next(XrCompositionLayerDepthTestVARJO value)

Prepends the specified XrCompositionLayerDepthTestVARJO value to the next chain.

public XrCompositionLayerProjection
next(XrCompositionLayerReprojectionInfoMSFT value)

Prepends the specified XrCompositionLayerReprojectionInfoMSFT value to the next chain.

public XrCompositionLayerProjection
public static long
nlayerFlags(long struct)

Unsafe version of layerFlags.

public static void
nlayerFlags(long struct, long value)

Unsafe version of layerFlags.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
nspace(long struct)

Unsafe version of space.

public static void
nspace(long struct, XrSpace value)

Unsafe version of space.

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
nviewCount(long struct)

Unsafe version of viewCount.

public static void
nviewCount(long struct, int value)

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

public static XrCompositionLayerProjectionView.Buffer
nviews(long struct)

Unsafe version of views.

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

Unsafe version of views.

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

Initializes this struct with the specified values.

public XrCompositionLayerProjection

Returns:

this struct
set
(XrCompositionLayerProjection
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 long
space()

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

public XrCompositionLayerProjection
space(XrSpace value)

Sets the specified value to the space field.

public int
type()

the XrStructureType of this structure.

public XrCompositionLayerProjection
type(int value)

Sets the specified value to the type field.

public XrCompositionLayerProjection
type$Default()

Sets the TYPE_COMPOSITION_LAYER_PROJECTION value to the type field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public int
viewCount()

the count of views in the views array.

public XrCompositionLayerProjectionView.Buffer
views()

the array of type XrCompositionLayerProjectionView containing each projection layer view.

public XrCompositionLayerProjection
views(XrCompositionLayerProjectionView.Buffer value)

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

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

LAYERFLAGSback to summary
public static final int LAYERFLAGS

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SPACEback to summary
public static final int SPACE

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

VIEWCOUNTback to summary
public static final int VIEWCOUNT

The struct member offsets.

VIEWSback to summary
public static final int VIEWS

The struct member offsets.

Constructor Detail

XrCompositionLayerProjectionback to summary
protected XrCompositionLayerProjection(long address, ByteBuffer container)
XrCompositionLayerProjectionback to summary
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 Detail

callocback to summary
public static XrCompositionLayerProjection calloc()

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

callocback to summary
public static XrCompositionLayerProjection.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrCompositionLayerProjection calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrCompositionLayerProjection.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected XrCompositionLayerProjection 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
createback to summary
public static XrCompositionLayerProjection create()

Returns a new XrCompositionLayerProjection instance allocated with BufferUtils.

createback to summary
public static XrCompositionLayerProjection create(long address)

Returns a new XrCompositionLayerProjection instance for the specified memory address.

createback to summary
public static XrCompositionLayerProjection create(XrCompositionLayerBaseHeader value)

Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerProjection.

createback to summary
public static XrCompositionLayerProjection.Buffer create(int capacity)

Returns a new XrCompositionLayerProjection.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrCompositionLayerProjection.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createback to summary
public static XrCompositionLayerProjection.Buffer create(XrCompositionLayerBaseHeader.Buffer value)

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

createSafeback to summary
public static XrCompositionLayerProjection createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrCompositionLayerProjection.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
layerFlagsback to summary
public long layerFlags()

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

Annotations
@NativeType:XrCompositionLayerFlags
layerFlagsback to summary
public XrCompositionLayerProjection layerFlags(long value)

Sets the specified value to the layerFlags field.

mallocback to summary
public static XrCompositionLayerProjection malloc()

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

mallocback to summary
public static XrCompositionLayerProjection.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrCompositionLayerProjection malloc(MemoryStack stack)

Returns a new XrCompositionLayerProjection instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrCompositionLayerProjection.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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

Annotations
@NativeType:void const *
nextback to summary
public XrCompositionLayerProjection next(long value)

Sets the specified value to the next field.

nextback to summary
public XrCompositionLayerProjection next(XrCompositionLayerDepthTestVARJO value)

Prepends the specified XrCompositionLayerDepthTestVARJO value to the next chain.

nextback to summary
public XrCompositionLayerProjection next(XrCompositionLayerReprojectionInfoMSFT value)

Prepends the specified XrCompositionLayerReprojectionInfoMSFT value to the next chain.

nextback to summary
public XrCompositionLayerProjection next(XrCompositionLayerReprojectionPlaneOverrideMSFT value)

Prepends the specified XrCompositionLayerReprojectionPlaneOverrideMSFT value to the next chain.

nlayerFlagsback to summary
public static long nlayerFlags(long struct)

Unsafe version of layerFlags.

nlayerFlagsback to summary
public static void nlayerFlags(long struct, long value)

Unsafe version of layerFlags.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nspaceback to summary
public static long nspace(long struct)

Unsafe version of space.

nspaceback to summary
public static void nspace(long struct, XrSpace value)

Unsafe version of space.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

nviewCountback to summary
public static int nviewCount(long struct)

Unsafe version of viewCount.

nviewCountback to summary
public static void nviewCount(long struct, int value)

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

nviewsback to summary
public static XrCompositionLayerProjectionView.Buffer nviews(long struct)

Unsafe version of views.

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

Unsafe version of views.

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

Initializes this struct with the specified values.

setback to summary
public XrCompositionLayerProjection set(XrCompositionLayerProjection src)

Copies the specified struct data to this struct.

Parameters
src:XrCompositionLayerProjection

the source struct

Returns:XrCompositionLayerProjection

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
spaceback to summary
public long space()

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

Annotations
@NativeType:XrSpace
spaceback to summary
public XrCompositionLayerProjection space(XrSpace value)

Sets the specified value to the space field.

typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrCompositionLayerProjection type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrCompositionLayerProjection type$Default()

Sets the TYPE_COMPOSITION_LAYER_PROJECTION value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

viewCountback to summary
public int viewCount()

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

Annotations
@NativeType:uint32_t
viewsback to summary
public XrCompositionLayerProjectionView.Buffer views()

the array of type XrCompositionLayerProjectionView containing each projection layer view.

Annotations
@NativeType:XrCompositionLayerProjectionView const *
viewsback to summary
public XrCompositionLayerProjection views(XrCompositionLayerProjectionView.Buffer value)

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

org.lwjgl.openxr back to summary

public Class XrCompositionLayerProjection.Buffer

extends StructBuffer<XrCompositionLayerProjection, XrCompositionLayerProjection.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrCompositionLayerProjection structs.

Field Summary

Modifier and TypeField and Description
private static final XrCompositionLayerProjection

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
protected XrCompositionLayerProjection
public long

Returns:

the value of the XrCompositionLayerProjection#layerFlags field.
layerFlags
()

public XrCompositionLayerProjection.Buffer
layerFlags(long value)

Sets the specified value to the XrCompositionLayerProjection#layerFlags field.

public long

Returns:

the value of the XrCompositionLayerProjection#next field.
next
()

public XrCompositionLayerProjection.Buffer
next(long value)

Sets the specified value to the XrCompositionLayerProjection#next field.

public XrCompositionLayerProjection.Buffer
next(XrCompositionLayerDepthTestVARJO value)

Prepends the specified XrCompositionLayerDepthTestVARJO value to the next chain.

public XrCompositionLayerProjection.Buffer
next(XrCompositionLayerReprojectionInfoMSFT value)

Prepends the specified XrCompositionLayerReprojectionInfoMSFT value to the next chain.

public XrCompositionLayerProjection.Buffer
protected XrCompositionLayerProjection.Buffer
public long

Returns:

the value of the XrCompositionLayerProjection#space field.
space
()

public XrCompositionLayerProjection.Buffer
space(XrSpace value)

Sets the specified value to the XrCompositionLayerProjection#space field.

public int

Returns:

the value of the XrCompositionLayerProjection#type field.
type
()

public XrCompositionLayerProjection.Buffer
type(int value)

Sets the specified value to the XrCompositionLayerProjection#type field.

public XrCompositionLayerProjection.Buffer
public int

Returns:

the value of the XrCompositionLayerProjection#viewCount field.
viewCount
()

public XrCompositionLayerProjectionView.Buffer

Returns:

a XrCompositionLayerProjectionView.Buffer view of the struct array pointed to by the XrCompositionLayerProjection#views field.
views
()

public XrCompositionLayerProjection.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrCompositionLayerProjection ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrCompositionLayerProjection.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrCompositionLayerProjection#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected XrCompositionLayerProjection getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
layerFlagsback to summary
public long layerFlags()
Returns:long

the value of the XrCompositionLayerProjection#layerFlags field.

Annotations
@NativeType:XrCompositionLayerFlags
layerFlagsback to summary
public XrCompositionLayerProjection.Buffer layerFlags(long value)

Sets the specified value to the XrCompositionLayerProjection#layerFlags field.

nextback to summary
public long next()
Returns:long

the value of the XrCompositionLayerProjection#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrCompositionLayerProjection.Buffer next(long value)

Sets the specified value to the XrCompositionLayerProjection#next field.

nextback to summary
public XrCompositionLayerProjection.Buffer next(XrCompositionLayerDepthTestVARJO value)

Prepends the specified XrCompositionLayerDepthTestVARJO value to the next chain.

nextback to summary
public XrCompositionLayerProjection.Buffer next(XrCompositionLayerReprojectionInfoMSFT value)

Prepends the specified XrCompositionLayerReprojectionInfoMSFT value to the next chain.

nextback to summary
public XrCompositionLayerProjection.Buffer next(XrCompositionLayerReprojectionPlaneOverrideMSFT value)

Prepends the specified XrCompositionLayerReprojectionPlaneOverrideMSFT value to the next chain.

selfback to summary
protected XrCompositionLayerProjection.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
spaceback to summary
public long space()
Returns:long

the value of the XrCompositionLayerProjection#space field.

Annotations
@NativeType:XrSpace
spaceback to summary
public XrCompositionLayerProjection.Buffer space(XrSpace value)

Sets the specified value to the XrCompositionLayerProjection#space field.

typeback to summary
public int type()
Returns:int

the value of the XrCompositionLayerProjection#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrCompositionLayerProjection.Buffer type(int value)

Sets the specified value to the XrCompositionLayerProjection#type field.

type$Defaultback to summary
public XrCompositionLayerProjection.Buffer type$Default()

Sets the TYPE_COMPOSITION_LAYER_PROJECTION value to the XrCompositionLayerProjection#type field.

viewCountback to summary
public int viewCount()
Returns:int

the value of the XrCompositionLayerProjection#viewCount field.

Annotations
@NativeType:uint32_t
viewsback to summary
public XrCompositionLayerProjectionView.Buffer views()
Returns:XrCompositionLayerProjectionView.Buffer

a XrCompositionLayerProjectionView.Buffer view of the struct array pointed to by the XrCompositionLayerProjection#views field.

Annotations
@NativeType:XrCompositionLayerProjectionView const *
viewsback to summary
public XrCompositionLayerProjection.Buffer views(XrCompositionLayerProjectionView.Buffer value)

Sets the address of the specified XrCompositionLayerProjectionView.Buffer to the XrCompositionLayerProjection#views field.