Package org.lwjgl.openxr

Class XrFacialExpressionClientCreateInfoML

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrFacialExpressionClientCreateInfoML>

org.lwjgl.openxr.XrFacialExpressionClientCreateInfoML

All Implemented Interfaces:

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

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

Information to create a facial expression handle.

Description

Note that although the naming convention for requestedCount does not align with requestedFacialBlendShapes, they are coupled together.

The XrFacialExpressionClientCreateInfoML structure describes the information to create an XrFacialExpressionClientML handle.

An application specifies the blend shapes they want to query by creating an array of type XrFacialBlendShapeML and passing it to requestedFacialBlendShapes along with the corresponding requestedCount.

The application can also pass in NULL into requestedFacialBlendShapes to capture the entirety of XrFacialBlendShapeML. However, for performance reasons, it may be better to be explicit about what blend shapes to query for performance reasons since some blend shapes may be queried by the runtime at a greater frequency than other blend shapes.

Valid Usage (Implicit)

• The XR_ML_facial_expression extension must be enabled prior to using XrFacialExpressionClientCreateInfoML
• type must be TYPE_FACIAL_EXPRESSION_CLIENT_CREATE_INFO_ML
• next must be NULL or a valid pointer to the next structure in a structure chain
• If requestedCount is not 0, requestedFacialBlendShapes must be a pointer to an array of requestedCount valid XrFacialBlendShapeML values

See Also

CreateFacialExpressionClientML, DestroyFacialExpressionClientML

Layout

 struct XrFacialExpressionClientCreateInfoML {
     XrStructureType type();
     void const * next();
     uint32_t requestedCount();
     XrFacialBlendShapeML const * requestedFacialBlendShapes();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrFacialExpressionClientCreateInfoML	calloc()	Returns a new XrFacialExpressionClientCreateInfoML instance allocated with memCalloc.
static XrFacialExpressionClientCreateInfoML.Buffer	calloc(int capacity)	Returns a new XrFacialExpressionClientCreateInfoML.Buffer instance allocated with memCalloc.
static XrFacialExpressionClientCreateInfoML.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFacialExpressionClientCreateInfoML.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFacialExpressionClientCreateInfoML	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFacialExpressionClientCreateInfoML instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFacialExpressionClientCreateInfoML	create()	Returns a new XrFacialExpressionClientCreateInfoML instance allocated with BufferUtils.
static XrFacialExpressionClientCreateInfoML.Buffer	create(int capacity)	Returns a new XrFacialExpressionClientCreateInfoML.Buffer instance allocated with BufferUtils.
static XrFacialExpressionClientCreateInfoML	create(long address)	Returns a new XrFacialExpressionClientCreateInfoML instance for the specified memory address.
static XrFacialExpressionClientCreateInfoML.Buffer	create(long address, int capacity)	Create a XrFacialExpressionClientCreateInfoML.Buffer instance at the specified memory.
static @Nullable XrFacialExpressionClientCreateInfoML	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrFacialExpressionClientCreateInfoML.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrFacialExpressionClientCreateInfoML	malloc()	Returns a new XrFacialExpressionClientCreateInfoML instance allocated with memAlloc.
static XrFacialExpressionClientCreateInfoML.Buffer	malloc(int capacity)	Returns a new XrFacialExpressionClientCreateInfoML.Buffer instance allocated with memAlloc.
static XrFacialExpressionClientCreateInfoML.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFacialExpressionClientCreateInfoML.Buffer instance allocated on the specified MemoryStack.
static XrFacialExpressionClientCreateInfoML	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFacialExpressionClientCreateInfoML instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrFacialExpressionClientCreateInfoML	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	nrequestedCount(long struct)	Unsafe version of requestedCount().
static void	nrequestedCount(long struct, int value)	Sets the specified value to the requestedCount field of the specified struct.
static @Nullable IntBuffer	nrequestedFacialBlendShapes(long struct)	Unsafe version of requestedFacialBlendShapes.
static void	nrequestedFacialBlendShapes(long struct, @Nullable IntBuffer value)	Unsafe version of requestedFacialBlendShapes.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	requestedCount()	the size of the requestedFacialBlendShapes array
XrFacialExpressionClientCreateInfoML	requestedCount(int value)	Sets the specified value to the requestedCount() field.
@Nullable IntBuffer	requestedFacialBlendShapes()	a pointer to an application defined array containing the blend shapes for the runtime to target.
XrFacialExpressionClientCreateInfoML	requestedFacialBlendShapes(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the requestedFacialBlendShapes() field.
XrFacialExpressionClientCreateInfoML	set(int type, long next, int requestedCount, @Nullable IntBuffer requestedFacialBlendShapes)	Initializes this struct with the specified values.
XrFacialExpressionClientCreateInfoML	set(XrFacialExpressionClientCreateInfoML src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrFacialExpressionClientCreateInfoML	type(int value)	Sets the specified value to the type() field.
XrFacialExpressionClientCreateInfoML	type$Default()	Sets the TYPE_FACIAL_EXPRESSION_CLIENT_CREATE_INFO_ML 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.

REQUESTEDCOUNT

public static final int REQUESTEDCOUNT

The struct member offsets.

REQUESTEDFACIALBLENDSHAPES

public static final int REQUESTEDFACIALBLENDSHAPES

The struct member offsets.

Constructor Details

XrFacialExpressionClientCreateInfoML

public XrFacialExpressionClientCreateInfoML(ByteBuffer container)

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

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.

requestedCount

public int requestedCount()

the size of the requestedFacialBlendShapes array

requestedFacialBlendShapes

public @Nullable IntBuffer requestedFacialBlendShapes()

a pointer to an application defined array containing the blend shapes for the runtime to target.

type

public XrFacialExpressionClientCreateInfoML type(int value)

Sets the specified value to the type() field.

type$Default

public XrFacialExpressionClientCreateInfoML type$Default()

Sets the TYPE_FACIAL_EXPRESSION_CLIENT_CREATE_INFO_ML value to the type() field.

next

public XrFacialExpressionClientCreateInfoML next(long value)

Sets the specified value to the next() field.

requestedCount

public XrFacialExpressionClientCreateInfoML requestedCount(int value)

Sets the specified value to the requestedCount() field.

requestedFacialBlendShapes

public XrFacialExpressionClientCreateInfoML requestedFacialBlendShapes(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the requestedFacialBlendShapes() field.

set

public XrFacialExpressionClientCreateInfoML set(int type,
 long next,
 int requestedCount,
 @Nullable IntBuffer requestedFacialBlendShapes)

Initializes this struct with the specified values.

set

public XrFacialExpressionClientCreateInfoML set(XrFacialExpressionClientCreateInfoML src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrFacialExpressionClientCreateInfoML malloc()

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

calloc

public static XrFacialExpressionClientCreateInfoML calloc()

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

create

public static XrFacialExpressionClientCreateInfoML create()

Returns a new XrFacialExpressionClientCreateInfoML instance allocated with BufferUtils.

create

public static XrFacialExpressionClientCreateInfoML create(long address)

Returns a new XrFacialExpressionClientCreateInfoML instance for the specified memory address.

createSafe

public static @Nullable XrFacialExpressionClientCreateInfoML createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrFacialExpressionClientCreateInfoML.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrFacialExpressionClientCreateInfoML.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrFacialExpressionClientCreateInfoML.Buffer create(int capacity)

Returns a new XrFacialExpressionClientCreateInfoML.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrFacialExpressionClientCreateInfoML.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrFacialExpressionClientCreateInfoML instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nrequestedCount

public static int nrequestedCount(long struct)

Unsafe version of requestedCount().

nrequestedFacialBlendShapes

public static @Nullable IntBuffer nrequestedFacialBlendShapes(long struct)

Unsafe version of requestedFacialBlendShapes.

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.

nrequestedCount

public static void nrequestedCount(long struct,
 int value)

Sets the specified value to the requestedCount field of the specified struct.

nrequestedFacialBlendShapes

public static void nrequestedFacialBlendShapes(long struct,
 @Nullable IntBuffer value)

Unsafe version of requestedFacialBlendShapes.