Package org.lwjgl.openxr

Class XrFoveationEyeTrackedStateMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrFoveationEyeTrackedStateMETA>

org.lwjgl.openxr.XrFoveationEyeTrackedStateMETA

All Implemented Interfaces:

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

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

Foveation data returned from the runtime.

Description

XrFoveationEyeTrackedStateMETA must be provided when calling GetFoveationEyeTrackedStateMETA. The runtime must interpret XrFoveationEyeTrackedStateMETA without any additional structs in its next chain in order to query eye tracked foveation state, e.g. the center of the foveal region.

Valid Usage (Implicit)

• The XR_META_foveation_eye_tracked extension must be enabled prior to using XrFoveationEyeTrackedStateMETA
• type must be TYPE_FOVEATION_EYE_TRACKED_STATE_META
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrVector2f, GetFoveationEyeTrackedStateMETA

Layout

 struct XrFoveationEyeTrackedStateMETA {
     XrStructureType type();
     void * next();
     XrVector2f foveationCenter()[XR_FOVEATION_CENTER_SIZE_META];
     XrFoveationEyeTrackedStateFlagsMETA flags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrFoveationEyeTrackedStateMETA.Buffer	An array of XrFoveationEyeTrackedStateMETA 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	FLAGS	The struct member offsets.
static final int	FOVEATIONCENTER	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
XrFoveationEyeTrackedStateMETA(ByteBuffer container)	Creates a XrFoveationEyeTrackedStateMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrFoveationEyeTrackedStateMETA	calloc()	Returns a new XrFoveationEyeTrackedStateMETA instance allocated with memCalloc.
static XrFoveationEyeTrackedStateMETA.Buffer	calloc(int capacity)	Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated with memCalloc.
static XrFoveationEyeTrackedStateMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFoveationEyeTrackedStateMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationEyeTrackedStateMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFoveationEyeTrackedStateMETA	create()	Returns a new XrFoveationEyeTrackedStateMETA instance allocated with BufferUtils.
static XrFoveationEyeTrackedStateMETA.Buffer	create(int capacity)	Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated with BufferUtils.
static XrFoveationEyeTrackedStateMETA	create(long address)	Returns a new XrFoveationEyeTrackedStateMETA instance for the specified memory address.
static XrFoveationEyeTrackedStateMETA.Buffer	create(long address, int capacity)	Create a XrFoveationEyeTrackedStateMETA.Buffer instance at the specified memory.
static @Nullable XrFoveationEyeTrackedStateMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrFoveationEyeTrackedStateMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	flags()	a bitmask of XrFoveationEyeTrackedStateFlagBitsMETA which indicates various characteristics for current foveation state.
XrVector2f.Buffer	foveationCenter()	the center of the foveal region defined in NDC space in the range of -1 to 1 for both eyes.
XrVector2f	foveationCenter(int index)	the center of the foveal region defined in NDC space in the range of -1 to 1 for both eyes.
static XrFoveationEyeTrackedStateMETA	malloc()	Returns a new XrFoveationEyeTrackedStateMETA instance allocated with memAlloc.
static XrFoveationEyeTrackedStateMETA.Buffer	malloc(int capacity)	Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated with memAlloc.
static XrFoveationEyeTrackedStateMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated on the specified MemoryStack.
static XrFoveationEyeTrackedStateMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationEyeTrackedStateMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrFoveationEyeTrackedStateMETA	next(long value)	Sets the specified value to the next() field.
static long	nflags(long struct)	Unsafe version of flags().
static XrVector2f.Buffer	nfoveationCenter(long struct)	Unsafe version of foveationCenter().
static XrVector2f	nfoveationCenter(long struct, int index)	Unsafe version of foveationCenter.
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.
XrFoveationEyeTrackedStateMETA	set(int type, long next)	Initializes this struct with the specified values.
XrFoveationEyeTrackedStateMETA	set(XrFoveationEyeTrackedStateMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrFoveationEyeTrackedStateMETA	type(int value)	Sets the specified value to the type() field.
XrFoveationEyeTrackedStateMETA	type$Default()	Sets the TYPE_FOVEATION_EYE_TRACKED_STATE_META value to the type() 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.

FOVEATIONCENTER

public static final int FOVEATIONCENTER

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

XrFoveationEyeTrackedStateMETA

public XrFoveationEyeTrackedStateMETA(ByteBuffer container)

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

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 or this extension.

foveationCenter

public XrVector2f.Buffer foveationCenter()

the center of the foveal region defined in NDC space in the range of -1 to 1 for both eyes.

foveationCenter

public XrVector2f foveationCenter(int index)

the center of the foveal region defined in NDC space in the range of -1 to 1 for both eyes.

flags

public long flags()

a bitmask of XrFoveationEyeTrackedStateFlagBitsMETA which indicates various characteristics for current foveation state.

type

public XrFoveationEyeTrackedStateMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrFoveationEyeTrackedStateMETA type$Default()

Sets the TYPE_FOVEATION_EYE_TRACKED_STATE_META value to the type() field.

next

public XrFoveationEyeTrackedStateMETA next(long value)

Sets the specified value to the next() field.

set

public XrFoveationEyeTrackedStateMETA set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrFoveationEyeTrackedStateMETA set(XrFoveationEyeTrackedStateMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrFoveationEyeTrackedStateMETA malloc()

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

calloc

public static XrFoveationEyeTrackedStateMETA calloc()

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

create

public static XrFoveationEyeTrackedStateMETA create()

Returns a new XrFoveationEyeTrackedStateMETA instance allocated with BufferUtils.

create

public static XrFoveationEyeTrackedStateMETA create(long address)

Returns a new XrFoveationEyeTrackedStateMETA instance for the specified memory address.

createSafe

public static @Nullable XrFoveationEyeTrackedStateMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrFoveationEyeTrackedStateMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrFoveationEyeTrackedStateMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrFoveationEyeTrackedStateMETA.Buffer create(int capacity)

Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrFoveationEyeTrackedStateMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrFoveationEyeTrackedStateMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nfoveationCenter

public static XrVector2f.Buffer nfoveationCenter(long struct)

Unsafe version of foveationCenter().

nfoveationCenter

public static XrVector2f nfoveationCenter(long struct,
 int index)

Unsafe version of foveationCenter.

nflags

public static long nflags(long struct)

Unsafe version of flags().

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.