Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrFoveationEyeTrackedStateMETA

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

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)
See Also

XrVector2f, GetFoveationEyeTrackedStateMETA

Layout


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

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
FLAGS

The struct member offsets.

public static final int
FOVEATIONCENTER

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

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
XrFoveationEyeTrackedStateMETA(long address, ByteBuffer container)

public
XrFoveationEyeTrackedStateMETA(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrFoveationEyeTrackedStateMETA
calloc()

Returns a new XrFoveationEyeTrackedStateMETA instance allocated with memCalloc.

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

Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrFoveationEyeTrackedStateMETA instance allocated with BufferUtils.

public static XrFoveationEyeTrackedStateMETA
create(long address)

Returns a new XrFoveationEyeTrackedStateMETA instance for the specified memory address.

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

Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated with BufferUtils.

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

Create a XrFoveationEyeTrackedStateMETA.Buffer instance at the specified memory.

public static XrFoveationEyeTrackedStateMETA
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
flags()

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

public XrVector2f.Buffer
foveationCenter()

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

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.

public static XrFoveationEyeTrackedStateMETA
malloc()

Returns a new XrFoveationEyeTrackedStateMETA instance allocated with memAlloc.

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

Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated with memAlloc.

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

Returns a new XrFoveationEyeTrackedStateMETA instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrFoveationEyeTrackedStateMETA
next(long value)

Sets the specified value to the next field.

public static long
nflags(long struct)

Unsafe version of flags.

public static XrVector2f.Buffer
nfoveationCenter(long struct)

Unsafe version of foveationCenter.

public static XrVector2f
nfoveationCenter(long struct, int index)

Unsafe version of foveationCenter.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrFoveationEyeTrackedStateMETA
set(int type, long next)

Initializes this struct with the specified values.

public XrFoveationEyeTrackedStateMETA

Returns:

this struct
set
(XrFoveationEyeTrackedStateMETA
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 int
type()

the XrStructureType of this structure.

public XrFoveationEyeTrackedStateMETA
type(int value)

Sets the specified value to the type field.

public XrFoveationEyeTrackedStateMETA
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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

FOVEATIONCENTERback to summary
public static final int FOVEATIONCENTER

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrFoveationEyeTrackedStateMETAback to summary
protected XrFoveationEyeTrackedStateMETA(long address, ByteBuffer container)
XrFoveationEyeTrackedStateMETAback to summary
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 Detail

callocback to summary
public static XrFoveationEyeTrackedStateMETA calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrFoveationEyeTrackedStateMETA calloc(MemoryStack stack)

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

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

Returns a new XrFoveationEyeTrackedStateMETA instance allocated with BufferUtils.

createback to summary
public static XrFoveationEyeTrackedStateMETA create(long address)

Returns a new XrFoveationEyeTrackedStateMETA instance for the specified memory address.

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

Returns a new XrFoveationEyeTrackedStateMETA.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrFoveationEyeTrackedStateMETA.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrFoveationEyeTrackedStateMETA createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public long flags()

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

Annotations
@NativeType:XrFoveationEyeTrackedStateFlagsMETA
foveationCenterback to summary
public XrVector2f.Buffer foveationCenter()

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

Annotations
@NativeType:XrVector2f[XR_FOVEATION_CENTER_SIZE_META]
foveationCenterback to summary
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.

mallocback to summary
public static XrFoveationEyeTrackedStateMETA malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrFoveationEyeTrackedStateMETA malloc(MemoryStack stack)

Returns a new XrFoveationEyeTrackedStateMETA instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrFoveationEyeTrackedStateMETA.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 or this extension.

Annotations
@NativeType:void *
nextback to summary
public XrFoveationEyeTrackedStateMETA next(long value)

Sets the specified value to the next field.

nflagsback to summary
public static long nflags(long struct)

Unsafe version of flags.

nfoveationCenterback to summary
public static XrVector2f.Buffer nfoveationCenter(long struct)

Unsafe version of foveationCenter.

nfoveationCenterback to summary
public static XrVector2f nfoveationCenter(long struct, int index)

Unsafe version of foveationCenter.

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.

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.

setback to summary
public XrFoveationEyeTrackedStateMETA set(int type, long next)

Initializes this struct with the specified values.

setback to summary
public XrFoveationEyeTrackedStateMETA set(XrFoveationEyeTrackedStateMETA src)

Copies the specified struct data to this struct.

Parameters
src:XrFoveationEyeTrackedStateMETA

the source struct

Returns:XrFoveationEyeTrackedStateMETA

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
typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_FOVEATION_EYE_TRACKED_STATE_META value to the type field.

org.lwjgl.openxr back to summary

public Class XrFoveationEyeTrackedStateMETA.Buffer

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

An array of XrFoveationEyeTrackedStateMETA structs.

Field Summary

Modifier and TypeField and Description
private static final XrFoveationEyeTrackedStateMETA

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrFoveationEyeTrackedStateMETA.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 long

Returns:

the value of the XrFoveationEyeTrackedStateMETA#flags field.
flags
()

public XrVector2f.Buffer
public XrVector2f

Returns:

a XrVector2f view of the struct at the specified index of the XrFoveationEyeTrackedStateMETA#foveationCenter field.
foveationCenter
(int index)

protected XrFoveationEyeTrackedStateMETA
public long

Returns:

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

public XrFoveationEyeTrackedStateMETA.Buffer
next(long value)

Sets the specified value to the XrFoveationEyeTrackedStateMETA#next field.

protected XrFoveationEyeTrackedStateMETA.Buffer
public int

Returns:

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

public XrFoveationEyeTrackedStateMETA.Buffer
type(int value)

Sets the specified value to the XrFoveationEyeTrackedStateMETA#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrFoveationEyeTrackedStateMETA ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public long flags()
Returns:long

the value of the XrFoveationEyeTrackedStateMETA#flags field.

Annotations
@NativeType:XrFoveationEyeTrackedStateFlagsMETA
foveationCenterback to summary
public XrVector2f.Buffer foveationCenter()
Returns:XrVector2f.Buffer

a XrVector2f.Buffer view of the XrFoveationEyeTrackedStateMETA#foveationCenter field.

Annotations
@NativeType:XrVector2f[XR_FOVEATION_CENTER_SIZE_META]
foveationCenterback to summary
public XrVector2f foveationCenter(int index)
Returns:XrVector2f

a XrVector2f view of the struct at the specified index of the XrFoveationEyeTrackedStateMETA#foveationCenter field.

getElementFactoryback to summary
protected XrFoveationEyeTrackedStateMETA getElementFactory()

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

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

the value of the XrFoveationEyeTrackedStateMETA#next field.

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

Sets the specified value to the XrFoveationEyeTrackedStateMETA#next field.

selfback to summary
protected XrFoveationEyeTrackedStateMETA.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrFoveationEyeTrackedStateMETA#type field.

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

Sets the specified value to the XrFoveationEyeTrackedStateMETA#type field.

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

Sets the TYPE_FOVEATION_EYE_TRACKED_STATE_META value to the XrFoveationEyeTrackedStateMETA#type field.