Package org.lwjgl.openxr

Class XrCompositionLayerProjectionView

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerProjectionView>

org.lwjgl.openxr.XrCompositionLayerProjectionView

All Implemented Interfaces:

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

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

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)

• type must be TYPE_COMPOSITION_LAYER_PROJECTION_VIEW
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrCompositionLayerDepthInfoKHR, XrCompositionLayerSpaceWarpInfoFB
• subImage must be a valid XrSwapchainSubImage structure

See Also

XrCompositionLayerProjection, XrFovf, XrPosef, XrSwapchainSubImage

Layout

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerProjectionView	calloc()	Returns a new XrCompositionLayerProjectionView instance allocated with memCalloc.
static XrCompositionLayerProjectionView.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerProjectionView.Buffer instance allocated with memCalloc.
static XrCompositionLayerProjectionView.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerProjectionView.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerProjectionView	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerProjectionView instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerProjectionView	create()	Returns a new XrCompositionLayerProjectionView instance allocated with BufferUtils.
static XrCompositionLayerProjectionView.Buffer	create(int capacity)	Returns a new XrCompositionLayerProjectionView.Buffer instance allocated with BufferUtils.
static XrCompositionLayerProjectionView	create(long address)	Returns a new XrCompositionLayerProjectionView instance for the specified memory address.
static XrCompositionLayerProjectionView.Buffer	create(long address, int capacity)	Create a XrCompositionLayerProjectionView.Buffer instance at the specified memory.
static @Nullable XrCompositionLayerProjectionView	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerProjectionView.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
XrFovf	fov()	the XrFovf for this projection element.
XrCompositionLayerProjectionView	fov(Consumer<XrFovf> consumer)	Passes the fov() field to the specified Consumer.
XrCompositionLayerProjectionView	fov(XrFovf value)	Copies the specified XrFovf to the fov() field.
static XrCompositionLayerProjectionView	malloc()	Returns a new XrCompositionLayerProjectionView instance allocated with memAlloc.
static XrCompositionLayerProjectionView.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerProjectionView.Buffer instance allocated with memAlloc.
static XrCompositionLayerProjectionView.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerProjectionView.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerProjectionView	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerProjectionView instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerProjectionView	next(long value)	Sets the specified value to the next() field.
XrCompositionLayerProjectionView	next(XrCompositionLayerDepthInfoKHR value)	Prepends the specified XrCompositionLayerDepthInfoKHR value to the next chain.
XrCompositionLayerProjectionView	next(XrCompositionLayerSpaceWarpInfoFB value)	Prepends the specified XrCompositionLayerSpaceWarpInfoFB value to the next chain.
static XrFovf	nfov(long struct)	Unsafe version of fov().
static void	nfov(long struct, XrFovf value)	Unsafe version of fov.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static XrPosef	npose(long struct)	Unsafe version of pose().
static void	npose(long struct, XrPosef value)	Unsafe version of pose.
static XrSwapchainSubImage	nsubImage(long struct)	Unsafe version of subImage().
static void	nsubImage(long struct, XrSwapchainSubImage value)	Unsafe version of subImage.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrPosef	pose()	an XrPosef defining the location and orientation of this projection element in the space of the corresponding XrCompositionLayerProjectionView.
XrCompositionLayerProjectionView	pose(Consumer<XrPosef> consumer)	Passes the pose() field to the specified Consumer.
XrCompositionLayerProjectionView	pose(XrPosef value)	Copies the specified XrPosef to the pose() field.
XrCompositionLayerProjectionView	set(int type, long next, XrPosef pose, XrFovf fov, XrSwapchainSubImage subImage)	Initializes this struct with the specified values.
XrCompositionLayerProjectionView	set(XrCompositionLayerProjectionView src)	Copies the specified struct data to this struct.
int	sizeof()
XrSwapchainSubImage	subImage()	the image layer XrSwapchainSubImage to use.
XrCompositionLayerProjectionView	subImage(Consumer<XrSwapchainSubImage> consumer)	Passes the subImage() field to the specified Consumer.
XrCompositionLayerProjectionView	subImage(XrSwapchainSubImage value)	Copies the specified XrSwapchainSubImage to the subImage() field.
int	type()	the XrStructureType of this structure.
XrCompositionLayerProjectionView	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerProjectionView	type$Default()	Sets the TYPE_COMPOSITION_LAYER_PROJECTION_VIEW value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

POSE

public static final int POSE

The struct member offsets.

FOV

public static final int FOV

The struct member offsets.

SUBIMAGE

public static final int SUBIMAGE

The struct member offsets.

Constructor Details

XrCompositionLayerProjectionView

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrCompositionLayerProjectionView>

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.

pose

public XrPosef pose()

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

fov

public XrFovf fov()

the XrFovf for this projection element.

subImage

public XrSwapchainSubImage subImage()

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

type

public XrCompositionLayerProjectionView type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerProjectionView type$Default()

Sets the TYPE_COMPOSITION_LAYER_PROJECTION_VIEW value to the type() field.

next

public XrCompositionLayerProjectionView next(long value)

Sets the specified value to the next() field.

next

public XrCompositionLayerProjectionView next(XrCompositionLayerDepthInfoKHR value)

Prepends the specified XrCompositionLayerDepthInfoKHR value to the next chain.

next

public XrCompositionLayerProjectionView next(XrCompositionLayerSpaceWarpInfoFB value)

Prepends the specified XrCompositionLayerSpaceWarpInfoFB value to the next chain.

pose

public XrCompositionLayerProjectionView pose(XrPosef value)

Copies the specified XrPosef to the pose() field.

pose

public XrCompositionLayerProjectionView pose(Consumer<XrPosef> consumer)

Passes the pose() field to the specified Consumer.

fov

public XrCompositionLayerProjectionView fov(XrFovf value)

Copies the specified XrFovf to the fov() field.

fov

public XrCompositionLayerProjectionView fov(Consumer<XrFovf> consumer)

Passes the fov() field to the specified Consumer.

subImage

public XrCompositionLayerProjectionView subImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the subImage() field.

subImage

public XrCompositionLayerProjectionView subImage(Consumer<XrSwapchainSubImage> consumer)

Passes the subImage() field to the specified Consumer.

set

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

Initializes this struct with the specified values.

set

public XrCompositionLayerProjectionView set(XrCompositionLayerProjectionView src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerProjectionView malloc()

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

calloc

public static XrCompositionLayerProjectionView calloc()

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

create

public static XrCompositionLayerProjectionView create()

Returns a new XrCompositionLayerProjectionView instance allocated with BufferUtils.

create

public static XrCompositionLayerProjectionView create(long address)

Returns a new XrCompositionLayerProjectionView instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerProjectionView createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerProjectionView.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerProjectionView.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerProjectionView.Buffer create(int capacity)

Returns a new XrCompositionLayerProjectionView.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerProjectionView.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrCompositionLayerProjectionView instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npose

public static XrPosef npose(long struct)

Unsafe version of pose().

nfov

public static XrFovf nfov(long struct)

Unsafe version of fov().

nsubImage

public static XrSwapchainSubImage nsubImage(long struct)

Unsafe version of subImage().

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.

npose

public static void npose(long struct,
 XrPosef value)

Unsafe version of pose.

nfov

public static void nfov(long struct,
 XrFovf value)

Unsafe version of fov.

nsubImage

public static void nsubImage(long struct,
 XrSwapchainSubImage value)

Unsafe version of subImage.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate