System property for eye tracking.

Description

An application can inspect whether the system is capable of eye tracking input by extending the XrSystemProperties with XrSystemEyeTrackingPropertiesFB structure when calling GetSystemProperties.

If a runtime returns FALSE for supportsEyeTracking, the runtime must return ERROR_FEATURE_UNSUPPORTED from CreateEyeTrackerFB.

Valid Usage (Implicit)

The XR_FB_eye_tracking_social extension must be enabled prior to using XrSystemEyeTrackingPropertiesFB
type must be TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB
next must be NULL or a valid pointer to the next structure in a structure chain

Layout


struct XrSystemEyeTrackingPropertiesFB {
    XrStructureType type;
    void * next;
    XrBool32 supportsEyeTracking;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrSystemEyeTrackingPropertiesFB.Buffer An array of `XrSystemEyeTrackingPropertiesFB` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	NEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SUPPORTSEYETRACKING The struct member offsets.
public static final int	TYPE The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrSystemEyeTrackingPropertiesFB(long address, ByteBuffer container)
public	XrSystemEyeTrackingPropertiesFB(ByteBuffer container) Creates a `XrSystemEyeTrackingPropertiesFB` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrSystemEyeTrackingPropertiesFB	calloc() Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated with `memCalloc`.
public static XrSystemEyeTrackingPropertiesFB.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrSystemEyeTrackingPropertiesFB.Buffer` instance allocated with `memCalloc`.
public static XrSystemEyeTrackingPropertiesFB	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrSystemEyeTrackingPropertiesFB.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSystemEyeTrackingPropertiesFB.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrSystemEyeTrackingPropertiesFB	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 XrSystemEyeTrackingPropertiesFB	create() Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated with `BufferUtils`.
public static XrSystemEyeTrackingPropertiesFB	create(long address) Returns a new `XrSystemEyeTrackingPropertiesFB` instance for the specified memory address.
public static XrSystemEyeTrackingPropertiesFB.Buffer	create(int the buffer capacity capacity) Returns a new `XrSystemEyeTrackingPropertiesFB.Buffer` instance allocated with `BufferUtils`.
public static XrSystemEyeTrackingPropertiesFB.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrSystemEyeTrackingPropertiesFB.Buffer` instance at the specified memory.
public static XrSystemEyeTrackingPropertiesFB	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSystemEyeTrackingPropertiesFB.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSystemEyeTrackingPropertiesFB	malloc() Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated with `memAlloc`.
public static XrSystemEyeTrackingPropertiesFB.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrSystemEyeTrackingPropertiesFB.Buffer` instance allocated with `memAlloc`.
public static XrSystemEyeTrackingPropertiesFB	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated on the specified `MemoryStack`.
public static XrSystemEyeTrackingPropertiesFB.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSystemEyeTrackingPropertiesFB.Buffer` instance allocated on the specified `MemoryStack`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrSystemEyeTrackingPropertiesFB	next(long value) Sets the specified value to the `next` field.
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	nsupportsEyeTracking(long struct) Unsafe version of `supportsEyeTracking`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public XrSystemEyeTrackingPropertiesFB	set(int type, long next) Initializes this struct with the specified values.
public XrSystemEyeTrackingPropertiesFB	Returns: this struct set(XrSystemEyeTrackingPropertiesFB 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 boolean	supportsEyeTracking() an `XrBool32`, indicating if the current system is capable of receiving eye tracking input.
public int	type() the `XrStructureType` of this structure.
public XrSystemEyeTrackingPropertiesFB	type(int value) Sets the specified value to the `type` field.
public XrSystemEyeTrackingPropertiesFB	type$Default() Sets the `TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB` value to the `type` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

NEXT	back to summary
public static final int NEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

SUPPORTSEYETRACKING	back to summary
public static final int SUPPORTSEYETRACKING The struct member offsets.

TYPE	back to summary
public static final int TYPE The struct member offsets.

Constructor Detail

XrSystemEyeTrackingPropertiesFB	back to summary
protected XrSystemEyeTrackingPropertiesFB(long address, ByteBuffer container)

XrSystemEyeTrackingPropertiesFB back to summary

XrSystemEyeTrackingPropertiesFB	back to summary
public XrSystemEyeTrackingPropertiesFB(ByteBuffer container) Creates a `XrSystemEyeTrackingPropertiesFB` 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.

public XrSystemEyeTrackingPropertiesFB(ByteBuffer container)

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

calloc	back to summary
public static XrSystemEyeTrackingPropertiesFB calloc() Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrSystemEyeTrackingPropertiesFB.Buffer calloc(int capacity) Returns a new `XrSystemEyeTrackingPropertiesFB.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSystemEyeTrackingPropertiesFB.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrSystemEyeTrackingPropertiesFB calloc(MemoryStack stack) Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrSystemEyeTrackingPropertiesFB calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrSystemEyeTrackingPropertiesFB.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrSystemEyeTrackingPropertiesFB.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

public static XrSystemEyeTrackingPropertiesFB.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrSystemEyeTrackingPropertiesFB.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

create back to summary

create	back to summary
protected XrSystemEyeTrackingPropertiesFB 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

protected XrSystemEyeTrackingPropertiesFB 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

create	back to summary
public static XrSystemEyeTrackingPropertiesFB create() Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated with `BufferUtils`.

create	back to summary
public static XrSystemEyeTrackingPropertiesFB create(long address) Returns a new `XrSystemEyeTrackingPropertiesFB` instance for the specified memory address.

create back to summary

create	back to summary
public static XrSystemEyeTrackingPropertiesFB.Buffer create(int capacity) Returns a new `XrSystemEyeTrackingPropertiesFB.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrSystemEyeTrackingPropertiesFB.Buffer create(int capacity)

Returns a new XrSystemEyeTrackingPropertiesFB.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrSystemEyeTrackingPropertiesFB.Buffer create(long address, int capacity) Create a `XrSystemEyeTrackingPropertiesFB.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrSystemEyeTrackingPropertiesFB.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrSystemEyeTrackingPropertiesFB createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrSystemEyeTrackingPropertiesFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrSystemEyeTrackingPropertiesFB.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static XrSystemEyeTrackingPropertiesFB malloc() Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrSystemEyeTrackingPropertiesFB.Buffer malloc(int capacity) Returns a new `XrSystemEyeTrackingPropertiesFB.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSystemEyeTrackingPropertiesFB.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrSystemEyeTrackingPropertiesFB malloc(MemoryStack stack) Returns a new `XrSystemEyeTrackingPropertiesFB` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSystemEyeTrackingPropertiesFB malloc(MemoryStack stack)

Returns a new XrSystemEyeTrackingPropertiesFB instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrSystemEyeTrackingPropertiesFB.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSystemEyeTrackingPropertiesFB.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static XrSystemEyeTrackingPropertiesFB.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

next back to summary

next	back 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 *

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 *

next	back to summary
public XrSystemEyeTrackingPropertiesFB next(long value) Sets the specified value to the `next` field.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

nsupportsEyeTracking	back to summary
public static int nsupportsEyeTracking(long struct) Unsafe version of `supportsEyeTracking`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

set	back to summary
public XrSystemEyeTrackingPropertiesFB set(int type, long next) Initializes this struct with the specified values.

set	back to summary
public XrSystemEyeTrackingPropertiesFB set(XrSystemEyeTrackingPropertiesFB src) Copies the specified struct data to this struct. Parameters src:XrSystemEyeTrackingPropertiesFB the source struct Returns:XrSystemEyeTrackingPropertiesFB this struct

set

back to summary

public XrSystemEyeTrackingPropertiesFB set(XrSystemEyeTrackingPropertiesFB src)

Copies the specified struct data to this struct.

Parameters

src:XrSystemEyeTrackingPropertiesFB: the source struct

Returns:XrSystemEyeTrackingPropertiesFB

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

supportsEyeTracking back to summary

supportsEyeTracking	back to summary
public boolean supportsEyeTracking() an `XrBool32`, indicating if the current system is capable of receiving eye tracking input. Annotations @NativeType:XrBool32

public boolean supportsEyeTracking()

an XrBool32, indicating if the current system is capable of receiving eye tracking input.

Annotations

@NativeType:XrBool32

type back to summary

type	back to summary
public int type() the `XrStructureType` of this structure. Annotations @NativeType:XrStructureType

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrSystemEyeTrackingPropertiesFB type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrSystemEyeTrackingPropertiesFB type$Default() Sets the `TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB` value to the `type` field.

org.lwjgl.openxr back to summary

public Class XrSystemEyeTrackingPropertiesFB.Buffer

Class Inheritance

extends StructBuffer<XrSystemEyeTrackingPropertiesFB, XrSystemEyeTrackingPropertiesFB.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrSystemEyeTrackingPropertiesFB.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrSystemEyeTrackingPropertiesFB structs.

Field Summary

Modifier and Type	Field and Description
private static final XrSystemEyeTrackingPropertiesFB	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrSystemEyeTrackingPropertiesFB.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 Type	Method and Description
protected XrSystemEyeTrackingPropertiesFB	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `XrSystemEyeTrackingPropertiesFB#next` field. next()
public XrSystemEyeTrackingPropertiesFB.Buffer	next(long value) Sets the specified value to the `XrSystemEyeTrackingPropertiesFB#next` field.
protected XrSystemEyeTrackingPropertiesFB.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public boolean	Returns: the value of the `XrSystemEyeTrackingPropertiesFB#supportsEyeTracking` field. supportsEyeTracking()
public int	Returns: the value of the `XrSystemEyeTrackingPropertiesFB#type` field. type()
public XrSystemEyeTrackingPropertiesFB.Buffer	type(int value) Sets the specified value to the `XrSystemEyeTrackingPropertiesFB#type` field.
public XrSystemEyeTrackingPropertiesFB.Buffer	type$Default() Sets the `TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB` value to the `XrSystemEyeTrackingPropertiesFB#type` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrSystemEyeTrackingPropertiesFB ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrSystemEyeTrackingPropertiesFB.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 `XrSystemEyeTrackingPropertiesFB#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new XrSystemEyeTrackingPropertiesFB.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 XrSystemEyeTrackingPropertiesFB#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory	back to summary
protected XrSystemEyeTrackingPropertiesFB getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected XrSystemEyeTrackingPropertiesFB getElementFactory()

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

Annotations

@Override

next	back to summary
public long next() Returns:long the value of the `XrSystemEyeTrackingPropertiesFB#next` field. Annotations @NativeType:void *

next	back to summary
public XrSystemEyeTrackingPropertiesFB.Buffer next(long value) Sets the specified value to the `XrSystemEyeTrackingPropertiesFB#next` field.

self

back to summary

protected XrSystemEyeTrackingPropertiesFB.Buffer self()

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

Annotations

@Override

supportsEyeTracking	back to summary
public boolean supportsEyeTracking() Returns:boolean the value of the `XrSystemEyeTrackingPropertiesFB#supportsEyeTracking` field. Annotations @NativeType:XrBool32

type	back to summary
public int type() Returns:int the value of the `XrSystemEyeTrackingPropertiesFB#type` field. Annotations @NativeType:XrStructureType

type	back to summary
public XrSystemEyeTrackingPropertiesFB.Buffer type(int value) Sets the specified value to the `XrSystemEyeTrackingPropertiesFB#type` field.

type$Default	back to summary
public XrSystemEyeTrackingPropertiesFB.Buffer type$Default() Sets the `TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB` value to the `XrSystemEyeTrackingPropertiesFB#type` field.