Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrCompositionLayerProjectionView

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

Projection layer element.
Description

The count and order of view poses submitted with XrCompositionLayerProjection must be the same order as that returned by LocateViews. The XrCompositionLayerProjectionView::pose and XrCompositionLayerProjectionView::fov should almost always derive from XrView::pose and XrView::fov as found in the LocateViews::views array. However, applications may submit an XrCompositionLayerProjectionView which has a different view or FOV than that from LocateViews. In this case, the runtime will map the view and FOV to the system display appropriately. In the case that two submitted views within a single layer overlap, they must be composited in view array order.

Valid Usage (Implicit)
See Also

XrCompositionLayerProjection, XrFovf, XrPosef, XrSwapchainSubImage

Layout


struct XrCompositionLayerProjectionView {
    XrStructureType type;
    void const * next;
    XrPosef pose;
    XrFovf fov;
    XrSwapchainSubImage subImage;
}

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
FOV

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
POSE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUBIMAGE

The struct member offsets.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrCompositionLayerProjectionView(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrCompositionLayerProjectionView
calloc()

Returns a new XrCompositionLayerProjectionView instance allocated with memCalloc.

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

Returns a new XrCompositionLayerProjectionView.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrCompositionLayerProjectionView instance allocated with BufferUtils.

public static XrCompositionLayerProjectionView
create(long address)

Returns a new XrCompositionLayerProjectionView instance for the specified memory address.

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

Returns a new XrCompositionLayerProjectionView.Buffer instance allocated with BufferUtils.

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

Create a XrCompositionLayerProjectionView.Buffer instance at the specified memory.

public static XrCompositionLayerProjectionView
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public XrFovf
fov()

the XrFovf for this projection element.

public XrCompositionLayerProjectionView
fov(XrFovf value)

Copies the specified XrFovf to the fov field.

public XrCompositionLayerProjectionView
fov(Consumer<XrFovf> consumer)

Passes the fov field to the specified Consumer.

public static XrCompositionLayerProjectionView
malloc()

Returns a new XrCompositionLayerProjectionView instance allocated with memAlloc.

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

Returns a new XrCompositionLayerProjectionView.Buffer instance allocated with memAlloc.

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

Returns a new XrCompositionLayerProjectionView instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrCompositionLayerProjectionView
next(long value)

Sets the specified value to the next field.

public XrCompositionLayerProjectionView
next(XrCompositionLayerDepthInfoKHR value)

Prepends the specified XrCompositionLayerDepthInfoKHR value to the next chain.

public XrCompositionLayerProjectionView
next(XrCompositionLayerSpaceWarpInfoFB value)

Prepends the specified XrCompositionLayerSpaceWarpInfoFB value to the next chain.

public static XrFovf
nfov(long struct)

Unsafe version of fov.

public static void
nfov(long struct, XrFovf value)

Unsafe version of fov.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static XrPosef
npose(long struct)

Unsafe version of pose.

public static void
npose(long struct, XrPosef value)

Unsafe version of pose.

public static XrSwapchainSubImage
nsubImage(long struct)

Unsafe version of subImage.

public static void
nsubImage(long struct, XrSwapchainSubImage value)

Unsafe version of subImage.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrPosef
pose()

an XrPosef defining the location and orientation of this projection element in the space of the corresponding XrCompositionLayerProjectionView.

public XrCompositionLayerProjectionView
pose(XrPosef value)

Copies the specified XrPosef to the pose field.

public XrCompositionLayerProjectionView
pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

public XrCompositionLayerProjectionView
set(int type, long next, XrPosef pose, XrFovf fov, XrSwapchainSubImage subImage)

Initializes this struct with the specified values.

public XrCompositionLayerProjectionView

Returns:

this struct
set
(XrCompositionLayerProjectionView
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 XrSwapchainSubImage
subImage()

the image layer XrSwapchainSubImage to use.

public XrCompositionLayerProjectionView
subImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the subImage field.

public XrCompositionLayerProjectionView
subImage(Consumer<XrSwapchainSubImage> consumer)

Passes the subImage field to the specified Consumer.

public int
type()

the XrStructureType of this structure.

public XrCompositionLayerProjectionView
type(int value)

Sets the specified value to the type field.

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

Validates pointer members that should not be NULL.

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.

FOVback to summary
public static final int FOV

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

POSEback to summary
public static final int POSE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUBIMAGEback to summary
public static final int SUBIMAGE

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrCompositionLayerProjectionViewback to summary
protected XrCompositionLayerProjectionView(long address, ByteBuffer container)
XrCompositionLayerProjectionViewback to summary
public XrCompositionLayerProjectionView(ByteBuffer container)

Creates a XrCompositionLayerProjectionView 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 XrCompositionLayerProjectionView calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrCompositionLayerProjectionView calloc(MemoryStack stack)

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

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

Returns a new XrCompositionLayerProjectionView instance allocated with BufferUtils.

createback to summary
public static XrCompositionLayerProjectionView create(long address)

Returns a new XrCompositionLayerProjectionView instance for the specified memory address.

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

Returns a new XrCompositionLayerProjectionView.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrCompositionLayerProjectionView.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrCompositionLayerProjectionView createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
fovback to summary
public XrFovf fov()

the XrFovf for this projection element.

fovback to summary
public XrCompositionLayerProjectionView fov(XrFovf value)

Copies the specified XrFovf to the fov field.

fovback to summary
public XrCompositionLayerProjectionView fov(Consumer<XrFovf> consumer)

Passes the fov field to the specified Consumer.

mallocback to summary
public static XrCompositionLayerProjectionView malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrCompositionLayerProjectionView malloc(MemoryStack stack)

Returns a new XrCompositionLayerProjectionView instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrCompositionLayerProjectionView.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 XrCompositionLayerProjectionView next(long value)

Sets the specified value to the next field.

nextback to summary
public XrCompositionLayerProjectionView next(XrCompositionLayerDepthInfoKHR value)

Prepends the specified XrCompositionLayerDepthInfoKHR value to the next chain.

nextback to summary
public XrCompositionLayerProjectionView next(XrCompositionLayerSpaceWarpInfoFB value)

Prepends the specified XrCompositionLayerSpaceWarpInfoFB value to the next chain.

nfovback to summary
public static XrFovf nfov(long struct)

Unsafe version of fov.

nfovback to summary
public static void nfov(long struct, XrFovf value)

Unsafe version of fov.

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.

nposeback to summary
public static XrPosef npose(long struct)

Unsafe version of pose.

nposeback to summary
public static void npose(long struct, XrPosef value)

Unsafe version of pose.

nsubImageback to summary
public static XrSwapchainSubImage nsubImage(long struct)

Unsafe version of subImage.

nsubImageback to summary
public static void nsubImage(long struct, XrSwapchainSubImage value)

Unsafe version of subImage.

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.

poseback to summary
public XrPosef pose()

an XrPosef defining the location and orientation of this projection element in the space of the corresponding XrCompositionLayerProjectionView.

poseback to summary
public XrCompositionLayerProjectionView pose(XrPosef value)

Copies the specified XrPosef to the pose field.

poseback to summary
public XrCompositionLayerProjectionView pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

setback to summary
public XrCompositionLayerProjectionView set(int type, long next, XrPosef pose, XrFovf fov, XrSwapchainSubImage subImage)

Initializes this struct with the specified values.

setback to summary
public XrCompositionLayerProjectionView set(XrCompositionLayerProjectionView src)

Copies the specified struct data to this struct.

Parameters
src:XrCompositionLayerProjectionView

the source struct

Returns:XrCompositionLayerProjectionView

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
subImageback to summary
public XrSwapchainSubImage subImage()

the image layer XrSwapchainSubImage to use. The swapchain must have been created with a faceCount of 1.

subImageback to summary
public XrCompositionLayerProjectionView subImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the subImage field.

subImageback to summary
public XrCompositionLayerProjectionView subImage(Consumer<XrSwapchainSubImage> consumer)

Passes the subImage field to the specified Consumer.

typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_COMPOSITION_LAYER_PROJECTION_VIEW 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

org.lwjgl.openxr back to summary

public Class XrCompositionLayerProjectionView.Buffer

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

An array of XrCompositionLayerProjectionView structs.

Field Summary

Modifier and TypeField and Description
private static final XrCompositionLayerProjectionView

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrCompositionLayerProjectionView.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
public XrFovf

Returns:

a XrFovf view of the XrCompositionLayerProjectionView#fov field.
fov
()

public XrCompositionLayerProjectionView.Buffer
fov(XrFovf value)

Copies the specified XrFovf to the XrCompositionLayerProjectionView#fov field.

public XrCompositionLayerProjectionView.Buffer
fov(Consumer<XrFovf> consumer)

Passes the XrCompositionLayerProjectionView#fov field to the specified Consumer.

protected XrCompositionLayerProjectionView
public long

Returns:

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

public XrCompositionLayerProjectionView.Buffer
next(long value)

Sets the specified value to the XrCompositionLayerProjectionView#next field.

public XrCompositionLayerProjectionView.Buffer
next(XrCompositionLayerDepthInfoKHR value)

Prepends the specified XrCompositionLayerDepthInfoKHR value to the next chain.

public XrCompositionLayerProjectionView.Buffer
next(XrCompositionLayerSpaceWarpInfoFB value)

Prepends the specified XrCompositionLayerSpaceWarpInfoFB value to the next chain.

public XrPosef

Returns:

a XrPosef view of the XrCompositionLayerProjectionView#pose field.
pose
()

public XrCompositionLayerProjectionView.Buffer
pose(XrPosef value)

Copies the specified XrPosef to the XrCompositionLayerProjectionView#pose field.

public XrCompositionLayerProjectionView.Buffer
pose(Consumer<XrPosef> consumer)

Passes the XrCompositionLayerProjectionView#pose field to the specified Consumer.

protected XrCompositionLayerProjectionView.Buffer
public XrSwapchainSubImage
public XrCompositionLayerProjectionView.Buffer
public XrCompositionLayerProjectionView.Buffer
public int

Returns:

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

public XrCompositionLayerProjectionView.Buffer
type(int value)

Sets the specified value to the XrCompositionLayerProjectionView#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrCompositionLayerProjectionView ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrCompositionLayerProjectionView.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 XrCompositionLayerProjectionView#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

fovback to summary
public XrFovf fov()
Returns:XrFovf

a XrFovf view of the XrCompositionLayerProjectionView#fov field.

fovback to summary
public XrCompositionLayerProjectionView.Buffer fov(XrFovf value)

Copies the specified XrFovf to the XrCompositionLayerProjectionView#fov field.

fovback to summary
public XrCompositionLayerProjectionView.Buffer fov(Consumer<XrFovf> consumer)

Passes the XrCompositionLayerProjectionView#fov field to the specified Consumer.

getElementFactoryback to summary
protected XrCompositionLayerProjectionView getElementFactory()

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrCompositionLayerProjectionView#next field.

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

Sets the specified value to the XrCompositionLayerProjectionView#next field.

nextback to summary
public XrCompositionLayerProjectionView.Buffer next(XrCompositionLayerDepthInfoKHR value)

Prepends the specified XrCompositionLayerDepthInfoKHR value to the next chain.

nextback to summary
public XrCompositionLayerProjectionView.Buffer next(XrCompositionLayerSpaceWarpInfoFB value)

Prepends the specified XrCompositionLayerSpaceWarpInfoFB value to the next chain.

poseback to summary
public XrPosef pose()
Returns:XrPosef

a XrPosef view of the XrCompositionLayerProjectionView#pose field.

poseback to summary
public XrCompositionLayerProjectionView.Buffer pose(XrPosef value)

Copies the specified XrPosef to the XrCompositionLayerProjectionView#pose field.

poseback to summary
public XrCompositionLayerProjectionView.Buffer pose(Consumer<XrPosef> consumer)

Passes the XrCompositionLayerProjectionView#pose field to the specified Consumer.

selfback to summary
protected XrCompositionLayerProjectionView.Buffer self()

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

Annotations
@Override
subImageback to summary
public XrSwapchainSubImage subImage()
Returns:XrSwapchainSubImage

a XrSwapchainSubImage view of the XrCompositionLayerProjectionView#subImage field.

subImageback to summary
public XrCompositionLayerProjectionView.Buffer subImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the XrCompositionLayerProjectionView#subImage field.

subImageback to summary
public XrCompositionLayerProjectionView.Buffer subImage(Consumer<XrSwapchainSubImage> consumer)

Passes the XrCompositionLayerProjectionView#subImage field to the specified Consumer.

typeback to summary
public int type()
Returns:int

the value of the XrCompositionLayerProjectionView#type field.

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

Sets the specified value to the XrCompositionLayerProjectionView#type field.

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

Sets the TYPE_COMPOSITION_LAYER_PROJECTION_VIEW value to the XrCompositionLayerProjectionView#type field.