Package org.lwjgl.openxr

Class XrCompositionLayerReprojectionPlaneOverrideMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerReprojectionPlaneOverrideMSFT>

org.lwjgl.openxr.XrCompositionLayerReprojectionPlaneOverrideMSFT

All Implemented Interfaces:

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

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

Describe the parameters to override the reprojection plane.

Description

A runtime must return ERROR_VALIDATION_FAILURE if the normal vector deviates by more than 1% from unit length.

Adding a reprojection plane override may benefit various reprojection modes including REPROJECTION_MODE_DEPTH_MSFT, REPROJECTION_MODE_PLANAR_FROM_DEPTH_MSFT and REPROJECTION_MODE_PLANAR_MANUAL_MSFT.

When application choose REPROJECTION_MODE_ORIENTATION_ONLY_MSFT mode, the reprojection plane override may be ignored by the runtime.

Valid Usage (Implicit)

• The XR_MSFT_composition_layer_reprojection extension must be enabled prior to using XrCompositionLayerReprojectionPlaneOverrideMSFT
• type must be TYPE_COMPOSITION_LAYER_REPROJECTION_PLANE_OVERRIDE_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrVector3f

Layout

 struct XrCompositionLayerReprojectionPlaneOverrideMSFT {
     XrStructureType type();
     void const * next();
     XrVector3f position;
     XrVector3f normal();
     XrVector3f velocity();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerReprojectionPlaneOverrideMSFT	calloc()	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT instance allocated with memCalloc.
static XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer instance allocated with memCalloc.
static XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerReprojectionPlaneOverrideMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerReprojectionPlaneOverrideMSFT	create()	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT instance allocated with BufferUtils.
static XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer	create(int capacity)	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer instance allocated with BufferUtils.
static XrCompositionLayerReprojectionPlaneOverrideMSFT	create(long address)	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT instance for the specified memory address.
static XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer	create(long address, int capacity)	Create a XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer instance at the specified memory.
static @Nullable XrCompositionLayerReprojectionPlaneOverrideMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrCompositionLayerReprojectionPlaneOverrideMSFT	malloc()	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT instance allocated with memAlloc.
static XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer instance allocated with memAlloc.
static XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerReprojectionPlaneOverrideMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerReprojectionPlaneOverrideMSFT	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static XrVector3f	nnormal(long struct)	Unsafe version of normal().
static void	nnormal(long struct, XrVector3f value)	Unsafe version of normal.
XrVector3f	normal()	a unit vector describes the focus plane normal represented in the corresponding XrCompositionLayerProjection::space.
XrCompositionLayerReprojectionPlaneOverrideMSFT	normal(Consumer<XrVector3f> consumer)	Passes the normal() field to the specified Consumer.
XrCompositionLayerReprojectionPlaneOverrideMSFT	normal(XrVector3f value)	Copies the specified XrVector3f to the normal() field.
static XrVector3f	nposition$(long struct)	Unsafe version of position$().
static void	nposition$(long struct, XrVector3f value)	Unsafe version of position$.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static XrVector3f	nvelocity(long struct)	Unsafe version of velocity().
static void	nvelocity(long struct, XrVector3f value)	Unsafe version of velocity.
XrVector3f	position$()	describes the position of the focus plane represented in the corresponding XrCompositionLayerProjection::space.
XrCompositionLayerReprojectionPlaneOverrideMSFT	position$(Consumer<XrVector3f> consumer)	Passes the position$() field to the specified Consumer.
XrCompositionLayerReprojectionPlaneOverrideMSFT	position$(XrVector3f value)	Copies the specified XrVector3f to the position$() field.
XrCompositionLayerReprojectionPlaneOverrideMSFT	set(int type, long next, XrVector3f position$, XrVector3f normal, XrVector3f velocity)	Initializes this struct with the specified values.
XrCompositionLayerReprojectionPlaneOverrideMSFT	set(XrCompositionLayerReprojectionPlaneOverrideMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrCompositionLayerReprojectionPlaneOverrideMSFT	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerReprojectionPlaneOverrideMSFT	type$Default()	Sets the TYPE_COMPOSITION_LAYER_REPROJECTION_PLANE_OVERRIDE_MSFT value to the type() field.
XrVector3f	velocity()	a velocity of the position in the corresponding XrCompositionLayerProjection::space measured in meters per second.
XrCompositionLayerReprojectionPlaneOverrideMSFT	velocity(Consumer<XrVector3f> consumer)	Passes the velocity() field to the specified Consumer.
XrCompositionLayerReprojectionPlaneOverrideMSFT	velocity(XrVector3f value)	Copies the specified XrVector3f to the velocity() 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.

POSITION

public static final int POSITION

The struct member offsets.

NORMAL

public static final int NORMAL

The struct member offsets.

VELOCITY

public static final int VELOCITY

The struct member offsets.

Constructor Details

XrCompositionLayerReprojectionPlaneOverrideMSFT

public XrCompositionLayerReprojectionPlaneOverrideMSFT(ByteBuffer container)

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

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.

position$

public XrVector3f position$()

describes the position of the focus plane represented in the corresponding XrCompositionLayerProjection::space.

normal

public XrVector3f normal()

a unit vector describes the focus plane normal represented in the corresponding XrCompositionLayerProjection::space.

velocity

public XrVector3f velocity()

a velocity of the position in the corresponding XrCompositionLayerProjection::space measured in meters per second.

type

public XrCompositionLayerReprojectionPlaneOverrideMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerReprojectionPlaneOverrideMSFT type$Default()

Sets the TYPE_COMPOSITION_LAYER_REPROJECTION_PLANE_OVERRIDE_MSFT value to the type() field.

next

public XrCompositionLayerReprojectionPlaneOverrideMSFT next(long value)

Sets the specified value to the next() field.

position$

public XrCompositionLayerReprojectionPlaneOverrideMSFT position$(XrVector3f value)

Copies the specified XrVector3f to the position$() field.

position$

public XrCompositionLayerReprojectionPlaneOverrideMSFT position$(Consumer<XrVector3f> consumer)

Passes the position$() field to the specified Consumer.

normal

public XrCompositionLayerReprojectionPlaneOverrideMSFT normal(XrVector3f value)

Copies the specified XrVector3f to the normal() field.

normal

public XrCompositionLayerReprojectionPlaneOverrideMSFT normal(Consumer<XrVector3f> consumer)

Passes the normal() field to the specified Consumer.

velocity

public XrCompositionLayerReprojectionPlaneOverrideMSFT velocity(XrVector3f value)

Copies the specified XrVector3f to the velocity() field.

velocity

public XrCompositionLayerReprojectionPlaneOverrideMSFT velocity(Consumer<XrVector3f> consumer)

Passes the velocity() field to the specified Consumer.

set

public XrCompositionLayerReprojectionPlaneOverrideMSFT set(int type,
 long next,
 XrVector3f position$,
 XrVector3f normal,
 XrVector3f velocity)

Initializes this struct with the specified values.

set

public XrCompositionLayerReprojectionPlaneOverrideMSFT set(XrCompositionLayerReprojectionPlaneOverrideMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerReprojectionPlaneOverrideMSFT malloc()

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

calloc

public static XrCompositionLayerReprojectionPlaneOverrideMSFT calloc()

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

create

public static XrCompositionLayerReprojectionPlaneOverrideMSFT create()

Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT instance allocated with BufferUtils.

create

public static XrCompositionLayerReprojectionPlaneOverrideMSFT create(long address)

Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerReprojectionPlaneOverrideMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer create(int capacity)

Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerReprojectionPlaneOverrideMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrCompositionLayerReprojectionPlaneOverrideMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nposition$

public static XrVector3f nposition$(long struct)

Unsafe version of position$().

nnormal

public static XrVector3f nnormal(long struct)

Unsafe version of normal().

nvelocity

public static XrVector3f nvelocity(long struct)

Unsafe version of velocity().

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.

nposition$

public static void nposition$(long struct,
 XrVector3f value)

Unsafe version of position$.

nnormal

public static void nnormal(long struct,
 XrVector3f value)

Unsafe version of normal.

nvelocity

public static void nvelocity(long struct,
 XrVector3f value)

Unsafe version of velocity.