Package org.lwjgl.openxr

Class XrSystemFaceTrackingProperties2FB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemFaceTrackingProperties2FB>

org.lwjgl.openxr.XrSystemFaceTrackingProperties2FB

All Implemented Interfaces:

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

public class XrSystemFaceTrackingProperties2FB
extends org.lwjgl.system.Struct<XrSystemFaceTrackingProperties2FB>
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 XrSystemFaceTrackingProperties2FB structure when calling GetSystemProperties.

If an application calls CreateFaceTracker2FB only with unsupported XrFaceTrackerCreateInfo2FB::requestedDataSources, the runtime must return ERROR_FEATURE_UNSUPPORTED from CreateFaceTracker2FB. For example, if an application calls CreateFaceTracker2FB only with FACE_TRACKING_DATA_SOURCE2_AUDIO_FB in XrFaceTrackerCreateInfo2FB::requestedDataSources when the runtime returns FALSE for supportsAudioFaceTracking, the runtime must return ERROR_FEATURE_UNSUPPORTED from CreateFaceTracker2FB.

Valid Usage (Implicit)

• The XR_FB_face_tracking2 extension must be enabled prior to using XrSystemFaceTrackingProperties2FB
• type must be TYPE_SYSTEM_FACE_TRACKING_PROPERTIES2_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

Layout

 struct XrSystemFaceTrackingProperties2FB {
     XrStructureType type();
     void * next();
     XrBool32 supportsVisualFaceTracking();
     XrBool32 supportsAudioFaceTracking();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

SUPPORTSVISUALFACETRACKING

public static final int SUPPORTSVISUALFACETRACKING

The struct member offsets.

SUPPORTSAUDIOFACETRACKING

public static final int SUPPORTSAUDIOFACETRACKING

The struct member offsets.

Constructor Details

XrSystemFaceTrackingProperties2FB

public XrSystemFaceTrackingProperties2FB(ByteBuffer container)

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

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.

supportsVisualFaceTracking

public boolean supportsVisualFaceTracking()

an XrBool32, indicating if the current system is capable of receiving face tracking input that is estimated based on visual data source.

supportsAudioFaceTracking

public boolean supportsAudioFaceTracking()

an XrBool32, indicating if the current system is capable of receiving face tracking input that is estimated based on audio data source.

type

public XrSystemFaceTrackingProperties2FB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemFaceTrackingProperties2FB type$Default()

Sets the TYPE_SYSTEM_FACE_TRACKING_PROPERTIES2_FB value to the type() field.

next

public XrSystemFaceTrackingProperties2FB next(long value)

Sets the specified value to the next() field.

set

public XrSystemFaceTrackingProperties2FB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemFaceTrackingProperties2FB set(XrSystemFaceTrackingProperties2FB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemFaceTrackingProperties2FB malloc()

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

calloc

public static XrSystemFaceTrackingProperties2FB calloc()

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

create

public static XrSystemFaceTrackingProperties2FB create()

Returns a new XrSystemFaceTrackingProperties2FB instance allocated with BufferUtils.

create

public static XrSystemFaceTrackingProperties2FB create(long address)

Returns a new XrSystemFaceTrackingProperties2FB instance for the specified memory address.

createSafe

public static @Nullable XrSystemFaceTrackingProperties2FB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemFaceTrackingProperties2FB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemFaceTrackingProperties2FB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemFaceTrackingProperties2FB.Buffer create(int capacity)

Returns a new XrSystemFaceTrackingProperties2FB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemFaceTrackingProperties2FB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemFaceTrackingProperties2FB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportsVisualFaceTracking

public static int nsupportsVisualFaceTracking(long struct)

Unsafe version of supportsVisualFaceTracking().

nsupportsAudioFaceTracking

public static int nsupportsAudioFaceTracking(long struct)

Unsafe version of supportsAudioFaceTracking().

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.