Package org.lwjgl.openxr

Class XrCompositionLayerSpaceWarpInfoFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerSpaceWarpInfoFB>

org.lwjgl.openxr.XrCompositionLayerSpaceWarpInfoFB

All Implemented Interfaces:

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

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

Composition Layer Space Warp structure.

Description

The runtime must return error ERROR_VALIDATION_FAILURE if nearZ == farZ.

Valid Usage (Implicit)

• The XR_FB_space_warp extension must be enabled prior to using XrCompositionLayerSpaceWarpInfoFB
• type must be TYPE_COMPOSITION_LAYER_SPACE_WARP_INFO_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• layerFlags must be 0 or a valid combination of XrCompositionLayerSpaceWarpInfoFlagBitsFB values
• motionVectorSubImage must be a valid XrSwapchainSubImage structure
• depthSubImage must be a valid XrSwapchainSubImage structure

See Also

XrCompositionLayerBaseHeader, XrCompositionLayerProjection, XrCompositionLayerProjectionView, XrFrameEndInfo, XrPosef, XrSwapchainSubImage, EndFrame

Layout

 struct XrCompositionLayerSpaceWarpInfoFB {
     XrStructureType type();
     void const * next();
     XrCompositionLayerSpaceWarpInfoFlagsFB layerFlags();
     XrSwapchainSubImage motionVectorSubImage();
     XrPosef appSpaceDeltaPose();
     XrSwapchainSubImage depthSubImage();
     float minDepth();
     float maxDepth();
     float nearZ();
     float farZ();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrCompositionLayerSpaceWarpInfoFB.Buffer	An array of XrCompositionLayerSpaceWarpInfoFB 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	APPSPACEDELTAPOSE	The struct member offsets.
static final int	DEPTHSUBIMAGE	The struct member offsets.
static final int	FARZ	The struct member offsets.
static final int	LAYERFLAGS	The struct member offsets.
static final int	MAXDEPTH	The struct member offsets.
static final int	MINDEPTH	The struct member offsets.
static final int	MOTIONVECTORSUBIMAGE	The struct member offsets.
static final int	NEARZ	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
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
XrCompositionLayerSpaceWarpInfoFB(ByteBuffer container)	Creates a XrCompositionLayerSpaceWarpInfoFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
XrPosef	appSpaceDeltaPose()	the incremental application-applied transform, if any, since the previous frame that affects the view.
XrCompositionLayerSpaceWarpInfoFB	appSpaceDeltaPose(Consumer<XrPosef> consumer)	Passes the appSpaceDeltaPose() field to the specified Consumer.
XrCompositionLayerSpaceWarpInfoFB	appSpaceDeltaPose(XrPosef value)	Copies the specified XrPosef to the appSpaceDeltaPose() field.
static XrCompositionLayerSpaceWarpInfoFB	calloc()	Returns a new XrCompositionLayerSpaceWarpInfoFB instance allocated with memCalloc.
static XrCompositionLayerSpaceWarpInfoFB.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerSpaceWarpInfoFB.Buffer instance allocated with memCalloc.
static XrCompositionLayerSpaceWarpInfoFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerSpaceWarpInfoFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerSpaceWarpInfoFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerSpaceWarpInfoFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerSpaceWarpInfoFB	create()	Returns a new XrCompositionLayerSpaceWarpInfoFB instance allocated with BufferUtils.
static XrCompositionLayerSpaceWarpInfoFB.Buffer	create(int capacity)	Returns a new XrCompositionLayerSpaceWarpInfoFB.Buffer instance allocated with BufferUtils.
static XrCompositionLayerSpaceWarpInfoFB	create(long address)	Returns a new XrCompositionLayerSpaceWarpInfoFB instance for the specified memory address.
static XrCompositionLayerSpaceWarpInfoFB.Buffer	create(long address, int capacity)	Create a XrCompositionLayerSpaceWarpInfoFB.Buffer instance at the specified memory.
static @Nullable XrCompositionLayerSpaceWarpInfoFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerSpaceWarpInfoFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
XrSwapchainSubImage	depthSubImage()	identifies the depth image XrSwapchainSubImage to be associated with motionVectorSubImage.
XrCompositionLayerSpaceWarpInfoFB	depthSubImage(Consumer<XrSwapchainSubImage> consumer)	Passes the depthSubImage() field to the specified Consumer.
XrCompositionLayerSpaceWarpInfoFB	depthSubImage(XrSwapchainSubImage value)	Copies the specified XrSwapchainSubImage to the depthSubImage() field.
float	farZ()	the positive distance in meters of the maxDepth value in the depth swapchain.
XrCompositionLayerSpaceWarpInfoFB	farZ(float value)	Sets the specified value to the farZ() field.
long	layerFlags()	a bitmask of XrCompositionLayerSpaceWarpInfoFlagsFB.
XrCompositionLayerSpaceWarpInfoFB	layerFlags(long value)	Sets the specified value to the layerFlags() field.
static XrCompositionLayerSpaceWarpInfoFB	malloc()	Returns a new XrCompositionLayerSpaceWarpInfoFB instance allocated with memAlloc.
static XrCompositionLayerSpaceWarpInfoFB.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerSpaceWarpInfoFB.Buffer instance allocated with memAlloc.
static XrCompositionLayerSpaceWarpInfoFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerSpaceWarpInfoFB.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerSpaceWarpInfoFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerSpaceWarpInfoFB instance allocated on the specified MemoryStack.
float	maxDepth()	see minDepth
XrCompositionLayerSpaceWarpInfoFB	maxDepth(float value)	Sets the specified value to the maxDepth() field.
float	minDepth()	minDepth and maxDepth are the range of depth values the depth swapchain could have, in the range of [0.0,1.0].
XrCompositionLayerSpaceWarpInfoFB	minDepth(float value)	Sets the specified value to the minDepth() field.
XrSwapchainSubImage	motionVectorSubImage()	identifies the motion vector image XrSwapchainSubImage to be associated with the submitted layer XrCompositionLayerProjection.
XrCompositionLayerSpaceWarpInfoFB	motionVectorSubImage(Consumer<XrSwapchainSubImage> consumer)	Passes the motionVectorSubImage() field to the specified Consumer.
XrCompositionLayerSpaceWarpInfoFB	motionVectorSubImage(XrSwapchainSubImage value)	Copies the specified XrSwapchainSubImage to the motionVectorSubImage() field.
static XrPosef	nappSpaceDeltaPose(long struct)	Unsafe version of appSpaceDeltaPose().
static void	nappSpaceDeltaPose(long struct, XrPosef value)	Unsafe version of appSpaceDeltaPose.
static XrSwapchainSubImage	ndepthSubImage(long struct)	Unsafe version of depthSubImage().
static void	ndepthSubImage(long struct, XrSwapchainSubImage value)	Unsafe version of depthSubImage.
float	nearZ()	the positive distance in meters of the minDepth value in the depth swapchain.
XrCompositionLayerSpaceWarpInfoFB	nearZ(float value)	Sets the specified value to the nearZ() field.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerSpaceWarpInfoFB	next(long value)	Sets the specified value to the next() field.
static float	nfarZ(long struct)	Unsafe version of farZ().
static void	nfarZ(long struct, float value)	Unsafe version of farZ.
static long	nlayerFlags(long struct)	Unsafe version of layerFlags().
static void	nlayerFlags(long struct, long value)	Unsafe version of layerFlags.
static float	nmaxDepth(long struct)	Unsafe version of maxDepth().
static void	nmaxDepth(long struct, float value)	Unsafe version of maxDepth.
static float	nminDepth(long struct)	Unsafe version of minDepth().
static void	nminDepth(long struct, float value)	Unsafe version of minDepth.
static XrSwapchainSubImage	nmotionVectorSubImage(long struct)	Unsafe version of motionVectorSubImage().
static void	nmotionVectorSubImage(long struct, XrSwapchainSubImage value)	Unsafe version of motionVectorSubImage.
static float	nnearZ(long struct)	Unsafe version of nearZ().
static void	nnearZ(long struct, float value)	Unsafe version of nearZ.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrCompositionLayerSpaceWarpInfoFB	set(int type, long next, long layerFlags, XrSwapchainSubImage motionVectorSubImage, XrPosef appSpaceDeltaPose, XrSwapchainSubImage depthSubImage, float minDepth, float maxDepth, float nearZ, float farZ)	Initializes this struct with the specified values.
XrCompositionLayerSpaceWarpInfoFB	set(XrCompositionLayerSpaceWarpInfoFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrCompositionLayerSpaceWarpInfoFB	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerSpaceWarpInfoFB	type$Default()	Sets the TYPE_COMPOSITION_LAYER_SPACE_WARP_INFO_FB 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.

LAYERFLAGS

public static final int LAYERFLAGS

The struct member offsets.

MOTIONVECTORSUBIMAGE

public static final int MOTIONVECTORSUBIMAGE

The struct member offsets.

APPSPACEDELTAPOSE

public static final int APPSPACEDELTAPOSE

The struct member offsets.

DEPTHSUBIMAGE

public static final int DEPTHSUBIMAGE

The struct member offsets.

MINDEPTH

public static final int MINDEPTH

The struct member offsets.

MAXDEPTH

public static final int MAXDEPTH

The struct member offsets.

NEARZ

public static final int NEARZ

The struct member offsets.

FARZ

public static final int FARZ

The struct member offsets.

Constructor Details

XrCompositionLayerSpaceWarpInfoFB

public XrCompositionLayerSpaceWarpInfoFB(ByteBuffer container)

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

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.

layerFlags

public long layerFlags()

a bitmask of XrCompositionLayerSpaceWarpInfoFlagsFB.

motionVectorSubImage

public XrSwapchainSubImage motionVectorSubImage()

identifies the motion vector image XrSwapchainSubImage to be associated with the submitted layer XrCompositionLayerProjection.

appSpaceDeltaPose

public XrPosef appSpaceDeltaPose()

the incremental application-applied transform, if any, since the previous frame that affects the view. When artificial locomotion (scripted movement, teleportation, etc.) happens, the application might transform the whole XrCompositionLayerProjection::space from one application space pose to another pose between frames. The pose should be identity when there is no XrCompositionLayerProjection::space transformation in application.

depthSubImage

public XrSwapchainSubImage depthSubImage()

identifies the depth image XrSwapchainSubImage to be associated with motionVectorSubImage. The swapchain should be created with SWAPCHAIN_USAGE_SAMPLED_BIT | SWAPCHAIN_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.

minDepth

public float minDepth()

minDepth and maxDepth are the range of depth values the depth swapchain could have, in the range of [0.0,1.0]. This is akin to min and max values of OpenGL’s glDepthRange, but with the requirement here that maxDepth ≥ minDepth.

maxDepth

public float maxDepth()

see minDepth

nearZ

public float nearZ()

the positive distance in meters of the minDepth value in the depth swapchain. Applications may use a nearZ that is greater than farZ to indicate depth values are reversed. nearZ can be infinite.

farZ

public float farZ()

the positive distance in meters of the maxDepth value in the depth swapchain. farZ can be infinite.

type

public XrCompositionLayerSpaceWarpInfoFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerSpaceWarpInfoFB type$Default()

Sets the TYPE_COMPOSITION_LAYER_SPACE_WARP_INFO_FB value to the type() field.

next

public XrCompositionLayerSpaceWarpInfoFB next(long value)

Sets the specified value to the next() field.

layerFlags

public XrCompositionLayerSpaceWarpInfoFB layerFlags(long value)

Sets the specified value to the layerFlags() field.

motionVectorSubImage

public XrCompositionLayerSpaceWarpInfoFB motionVectorSubImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the motionVectorSubImage() field.

motionVectorSubImage

public XrCompositionLayerSpaceWarpInfoFB motionVectorSubImage(Consumer<XrSwapchainSubImage> consumer)

Passes the motionVectorSubImage() field to the specified Consumer.

appSpaceDeltaPose

public XrCompositionLayerSpaceWarpInfoFB appSpaceDeltaPose(XrPosef value)

Copies the specified XrPosef to the appSpaceDeltaPose() field.

appSpaceDeltaPose

public XrCompositionLayerSpaceWarpInfoFB appSpaceDeltaPose(Consumer<XrPosef> consumer)

Passes the appSpaceDeltaPose() field to the specified Consumer.

depthSubImage

public XrCompositionLayerSpaceWarpInfoFB depthSubImage(XrSwapchainSubImage value)

Copies the specified XrSwapchainSubImage to the depthSubImage() field.

depthSubImage

public XrCompositionLayerSpaceWarpInfoFB depthSubImage(Consumer<XrSwapchainSubImage> consumer)

Passes the depthSubImage() field to the specified Consumer.

minDepth

public XrCompositionLayerSpaceWarpInfoFB minDepth(float value)

Sets the specified value to the minDepth() field.

maxDepth

public XrCompositionLayerSpaceWarpInfoFB maxDepth(float value)

Sets the specified value to the maxDepth() field.

nearZ

public XrCompositionLayerSpaceWarpInfoFB nearZ(float value)

Sets the specified value to the nearZ() field.

farZ

public XrCompositionLayerSpaceWarpInfoFB farZ(float value)

Sets the specified value to the farZ() field.

set

public XrCompositionLayerSpaceWarpInfoFB set(int type,
 long next,
 long layerFlags,
 XrSwapchainSubImage motionVectorSubImage,
 XrPosef appSpaceDeltaPose,
 XrSwapchainSubImage depthSubImage,
 float minDepth,
 float maxDepth,
 float nearZ,
 float farZ)

Initializes this struct with the specified values.

set

public XrCompositionLayerSpaceWarpInfoFB set(XrCompositionLayerSpaceWarpInfoFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerSpaceWarpInfoFB malloc()

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

calloc

public static XrCompositionLayerSpaceWarpInfoFB calloc()

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

create

public static XrCompositionLayerSpaceWarpInfoFB create()

Returns a new XrCompositionLayerSpaceWarpInfoFB instance allocated with BufferUtils.

create

public static XrCompositionLayerSpaceWarpInfoFB create(long address)

Returns a new XrCompositionLayerSpaceWarpInfoFB instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerSpaceWarpInfoFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerSpaceWarpInfoFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerSpaceWarpInfoFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerSpaceWarpInfoFB.Buffer create(int capacity)

Returns a new XrCompositionLayerSpaceWarpInfoFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerSpaceWarpInfoFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrCompositionLayerSpaceWarpInfoFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmotionVectorSubImage

public static XrSwapchainSubImage nmotionVectorSubImage(long struct)

Unsafe version of motionVectorSubImage().

nappSpaceDeltaPose

public static XrPosef nappSpaceDeltaPose(long struct)

Unsafe version of appSpaceDeltaPose().

ndepthSubImage

public static XrSwapchainSubImage ndepthSubImage(long struct)

Unsafe version of depthSubImage().

nminDepth

public static float nminDepth(long struct)

Unsafe version of minDepth().

nmaxDepth

public static float nmaxDepth(long struct)

Unsafe version of maxDepth().

nnearZ

public static float nnearZ(long struct)

Unsafe version of nearZ().

nfarZ

public static float nfarZ(long struct)

Unsafe version of farZ().

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.

nmotionVectorSubImage

public static void nmotionVectorSubImage(long struct,
 XrSwapchainSubImage value)

Unsafe version of motionVectorSubImage.

nappSpaceDeltaPose

public static void nappSpaceDeltaPose(long struct,
 XrPosef value)

Unsafe version of appSpaceDeltaPose.

ndepthSubImage

public static void ndepthSubImage(long struct,
 XrSwapchainSubImage value)

Unsafe version of depthSubImage.

nminDepth

public static void nminDepth(long struct,
 float value)

Unsafe version of minDepth.

nmaxDepth

public static void nmaxDepth(long struct,
 float value)

Unsafe version of maxDepth.

nnearZ

public static void nnearZ(long struct,
 float value)

Unsafe version of nearZ.

nfarZ

public static void nfarZ(long struct,
 float value)

Unsafe version of farZ.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate