Package org.lwjgl.openxr

Class XrSystemFaceTrackingPropertiesFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemFaceTrackingPropertiesFB>

org.lwjgl.openxr.XrSystemFaceTrackingPropertiesFB

All Implemented Interfaces:

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

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

System property for face tracking.

Description

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

If a runtime returns FALSE for supportsFaceTracking, the runtime must return ERROR_FEATURE_UNSUPPORTED from CreateFaceTrackerFB.

Valid Usage (Implicit)

• The XR_FB_face_tracking extension must be enabled prior to using XrSystemFaceTrackingPropertiesFB
• type must be TYPE_SYSTEM_FACE_TRACKING_PROPERTIES_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

Layout

 struct XrSystemFaceTrackingPropertiesFB {
     XrStructureType type();
     void * next();
     XrBool32 supportsFaceTracking();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSystemFaceTrackingPropertiesFB.Buffer	An array of XrSystemFaceTrackingPropertiesFB 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	SUPPORTSFACETRACKING	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
XrSystemFaceTrackingPropertiesFB(ByteBuffer container)	Creates a XrSystemFaceTrackingPropertiesFB instance at the current position of the specified ByteBuffer container.

Method Summary

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

SUPPORTSFACETRACKING

public static final int SUPPORTSFACETRACKING

The struct member offsets.

Constructor Details

XrSystemFaceTrackingPropertiesFB

public XrSystemFaceTrackingPropertiesFB(ByteBuffer container)

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

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.

supportsFaceTracking

public boolean supportsFaceTracking()

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

type

public XrSystemFaceTrackingPropertiesFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemFaceTrackingPropertiesFB type$Default()

Sets the TYPE_SYSTEM_FACE_TRACKING_PROPERTIES_FB value to the type() field.

next

public XrSystemFaceTrackingPropertiesFB next(long value)

Sets the specified value to the next() field.

set

public XrSystemFaceTrackingPropertiesFB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemFaceTrackingPropertiesFB set(XrSystemFaceTrackingPropertiesFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemFaceTrackingPropertiesFB malloc()

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

calloc

public static XrSystemFaceTrackingPropertiesFB calloc()

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

create

public static XrSystemFaceTrackingPropertiesFB create()

Returns a new XrSystemFaceTrackingPropertiesFB instance allocated with BufferUtils.

create

public static XrSystemFaceTrackingPropertiesFB create(long address)

Returns a new XrSystemFaceTrackingPropertiesFB instance for the specified memory address.

createSafe

public static @Nullable XrSystemFaceTrackingPropertiesFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemFaceTrackingPropertiesFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemFaceTrackingPropertiesFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemFaceTrackingPropertiesFB.Buffer create(int capacity)

Returns a new XrSystemFaceTrackingPropertiesFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemFaceTrackingPropertiesFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemFaceTrackingPropertiesFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportsFaceTracking

public static int nsupportsFaceTracking(long struct)

Unsafe version of supportsFaceTracking().

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.