Package org.lwjgl.openxr

Class XrSystemEyeTrackingPropertiesFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemEyeTrackingPropertiesFB>

org.lwjgl.openxr.XrSystemEyeTrackingPropertiesFB

All Implemented Interfaces:

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

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

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 Class Summary

Nested Classes

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

Method Summary

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

SUPPORTSEYETRACKING

public static final int SUPPORTSEYETRACKING

The struct member offsets.

Constructor Details

XrSystemEyeTrackingPropertiesFB

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrSystemEyeTrackingPropertiesFB>

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.

supportsEyeTracking

public boolean supportsEyeTracking()

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

type

public XrSystemEyeTrackingPropertiesFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemEyeTrackingPropertiesFB type$Default()

Sets the TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB value to the type() field.

next

public XrSystemEyeTrackingPropertiesFB next(long value)

Sets the specified value to the next() field.

set

public XrSystemEyeTrackingPropertiesFB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemEyeTrackingPropertiesFB set(XrSystemEyeTrackingPropertiesFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemEyeTrackingPropertiesFB malloc()

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

calloc

public static XrSystemEyeTrackingPropertiesFB calloc()

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

create

public static XrSystemEyeTrackingPropertiesFB create()

Returns a new XrSystemEyeTrackingPropertiesFB instance allocated with BufferUtils.

create

public static XrSystemEyeTrackingPropertiesFB create(long address)

Returns a new XrSystemEyeTrackingPropertiesFB instance for the specified memory address.

createSafe

public static @Nullable XrSystemEyeTrackingPropertiesFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemEyeTrackingPropertiesFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemEyeTrackingPropertiesFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemEyeTrackingPropertiesFB.Buffer create(int capacity)

Returns a new XrSystemEyeTrackingPropertiesFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemEyeTrackingPropertiesFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemEyeTrackingPropertiesFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportsEyeTracking

public static int nsupportsEyeTracking(long struct)

Unsafe version of supportsEyeTracking().

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.