Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrFacialExpressionsHTC

extends Struct<XrFacialExpressionsHTC>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Returns the expression data.
Description

XrFacialExpressionsHTC structure returns data of a lip facial expression or an eye facial expression.

An application must preallocate the output expressionWeightings array that can contain at least expressionCount of float. expressionCount must be at least FACIAL_EXPRESSION_LIP_COUNT_HTC for FACIAL_TRACKING_TYPE_LIP_DEFAULT_HTC, and at least FACIAL_EXPRESSION_EYE_COUNT_HTC for FACIAL_TRACKING_TYPE_EYE_DEFAULT_HTC.

The application must set expressionCount as described by the XrFacialTrackingTypeHTC when creating the XrFacialTrackerHTC otherwise the runtime must return ERROR_VALIDATION_FAILURE.

The runtime must update the expressionWeightings array ordered so that the application can index elements using the corresponding facial tracker enum (e.g. XrEyeExpressionHTC or XrLipExpressionHTC) as described by XrFacialTrackingTypeHTC when creating the XrFacialTrackerHTC. For example, when the XrFacialTrackerHTC is created with facialTrackingType set to FACIAL_TRACKING_TYPE_EYE_DEFAULT_HTC, the application must set the expressionCount to FACIAL_EXPRESSION_EYE_COUNT_HTC, and the runtime must fill the expressionWeightings array ordered with eye expression data so that it can be indexed by the XrEyeExpressionHTC enum.

If the returned isActive is true, the runtime must fill the expressionWeightings array ordered.

If the returned isActive is false, it indicates the facial tracker did not detect the corresponding facial input or the application lost input focus.

If the input expressionCount is not sufficient to contain all output indices, the runtime must return ERROR_SIZE_INSUFFICIENT on calls to GetFacialExpressionsHTC and not change the content in expressionWeightings.

Valid Usage (Implicit)
See Also

GetFacialExpressionsHTC

Layout


struct XrFacialExpressionsHTC {
    XrStructureType type;
    void const * next;
    XrBool32 isActive;
    XrTime sampleTime;
    uint32_t expressionCount;
    float * expressionWeightings;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
EXPRESSIONCOUNT

The struct member offsets.

public static final int
EXPRESSIONWEIGHTINGS

The struct member offsets.

public static final int
ISACTIVE

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SAMPLETIME

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrFacialExpressionsHTC(long address, ByteBuffer container)

public
XrFacialExpressionsHTC(ByteBuffer container)

Creates a XrFacialExpressionsHTC instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrFacialExpressionsHTC
calloc()

Returns a new XrFacialExpressionsHTC instance allocated with memCalloc.

public static XrFacialExpressionsHTC.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrFacialExpressionsHTC.Buffer instance allocated with memCalloc.

public static XrFacialExpressionsHTC
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrFacialExpressionsHTC.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected XrFacialExpressionsHTC
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 XrFacialExpressionsHTC
create()

Returns a new XrFacialExpressionsHTC instance allocated with BufferUtils.

public static XrFacialExpressionsHTC
create(long address)

Returns a new XrFacialExpressionsHTC instance for the specified memory address.

public static XrFacialExpressionsHTC.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrFacialExpressionsHTC.Buffer instance allocated with BufferUtils.

public static XrFacialExpressionsHTC.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a XrFacialExpressionsHTC.Buffer instance at the specified memory.

public static XrFacialExpressionsHTC
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
expressionCount()

a uint32_t describing the count of elements in expressionWeightings array.

public XrFacialExpressionsHTC
expressionCount(int value)

Sets the specified value to the expressionCount field.

public FloatBuffer

Returns:

a float array filled in by the runtime, specifying the weightings for each blend shape.
expressionWeightings
(int
the number of elements in the returned buffer
capacity
)

public XrFacialExpressionsHTC
expressionWeightings(FloatBuffer value)

Sets the address of the specified FloatBuffer to the expressionWeightings field.

public boolean
isActive()

an XrBool32 indicating if the facial tracker is active.

public XrFacialExpressionsHTC
isActive(boolean value)

Sets the specified value to the isActive field.

public static XrFacialExpressionsHTC
malloc()

Returns a new XrFacialExpressionsHTC instance allocated with memAlloc.

public static XrFacialExpressionsHTC.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrFacialExpressionsHTC.Buffer instance allocated with memAlloc.

public static XrFacialExpressionsHTC
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrFacialExpressionsHTC instance allocated on the specified MemoryStack.

public static XrFacialExpressionsHTC.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static int
nexpressionCount(long struct)

Unsafe version of expressionCount.

public static void
nexpressionCount(long struct, int value)

Unsafe version of expressionCount.

public static FloatBuffer
nexpressionWeightings(long struct, int capacity)

Unsafe version of expressionWeightings.

public static void
nexpressionWeightings(long struct, FloatBuffer value)

Unsafe version of expressionWeightings.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrFacialExpressionsHTC
next(long value)

Sets the specified value to the next field.

public static int
nisActive(long struct)

Unsafe version of isActive.

public static void
nisActive(long struct, int value)

Unsafe version of isActive.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
nsampleTime(long struct)

Unsafe version of sampleTime.

public static void
nsampleTime(long struct, long value)

Unsafe version of sampleTime.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public long
sampleTime()

when in time the expression is expressed.

public XrFacialExpressionsHTC
sampleTime(long value)

Sets the specified value to the sampleTime field.

public XrFacialExpressionsHTC
set(int type, long next, boolean isActive, long sampleTime, int expressionCount, FloatBuffer expressionWeightings)

Initializes this struct with the specified values.

public XrFacialExpressionsHTC

Returns:

this struct
set
(XrFacialExpressionsHTC
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 int
type()

the XrStructureType of this structure.

public XrFacialExpressionsHTC
type(int value)

Sets the specified value to the type field.

public XrFacialExpressionsHTC
type$Default()

Sets the TYPE_FACIAL_EXPRESSIONS_HTC value to the type field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

EXPRESSIONCOUNTback to summary
public static final int EXPRESSIONCOUNT

The struct member offsets.

EXPRESSIONWEIGHTINGSback to summary
public static final int EXPRESSIONWEIGHTINGS

The struct member offsets.

ISACTIVEback to summary
public static final int ISACTIVE

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SAMPLETIMEback to summary
public static final int SAMPLETIME

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrFacialExpressionsHTCback to summary
protected XrFacialExpressionsHTC(long address, ByteBuffer container)
XrFacialExpressionsHTCback to summary
public XrFacialExpressionsHTC(ByteBuffer container)

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

callocback to summary
public static XrFacialExpressionsHTC calloc()

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

callocback to summary
public static XrFacialExpressionsHTC.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrFacialExpressionsHTC calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrFacialExpressionsHTC.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected XrFacialExpressionsHTC 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
createback to summary
public static XrFacialExpressionsHTC create()

Returns a new XrFacialExpressionsHTC instance allocated with BufferUtils.

createback to summary
public static XrFacialExpressionsHTC create(long address)

Returns a new XrFacialExpressionsHTC instance for the specified memory address.

createback to summary
public static XrFacialExpressionsHTC.Buffer create(int capacity)

Returns a new XrFacialExpressionsHTC.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static XrFacialExpressionsHTC.Buffer create(long address, int capacity)

Create a XrFacialExpressionsHTC.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrFacialExpressionsHTC createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrFacialExpressionsHTC.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
expressionCountback to summary
public int expressionCount()

a uint32_t describing the count of elements in expressionWeightings array.

Annotations
@NativeType:uint32_t
expressionCountback to summary
public XrFacialExpressionsHTC expressionCount(int value)

Sets the specified value to the expressionCount field.

expressionWeightingsback to summary
public FloatBuffer expressionWeightings(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:FloatBuffer

a float array filled in by the runtime, specifying the weightings for each blend shape.

Annotations
@NativeType:float *
expressionWeightingsback to summary
public XrFacialExpressionsHTC expressionWeightings(FloatBuffer value)

Sets the address of the specified FloatBuffer to the expressionWeightings field.

isActiveback to summary
public boolean isActive()

an XrBool32 indicating if the facial tracker is active.

Annotations
@NativeType:XrBool32
isActiveback to summary
public XrFacialExpressionsHTC isActive(boolean value)

Sets the specified value to the isActive field.

mallocback to summary
public static XrFacialExpressionsHTC malloc()

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

mallocback to summary
public static XrFacialExpressionsHTC.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrFacialExpressionsHTC malloc(MemoryStack stack)

Returns a new XrFacialExpressionsHTC instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrFacialExpressionsHTC.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nexpressionCountback to summary
public static int nexpressionCount(long struct)

Unsafe version of expressionCount.

nexpressionCountback to summary
public static void nexpressionCount(long struct, int value)

Unsafe version of expressionCount.

nexpressionWeightingsback to summary
public static FloatBuffer nexpressionWeightings(long struct, int capacity)

Unsafe version of expressionWeightings.

nexpressionWeightingsback to summary
public static void nexpressionWeightings(long struct, FloatBuffer value)

Unsafe version of expressionWeightings.

nextback 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 const *
nextback to summary
public XrFacialExpressionsHTC next(long value)

Sets the specified value to the next field.

nisActiveback to summary
public static int nisActive(long struct)

Unsafe version of isActive.

nisActiveback to summary
public static void nisActive(long struct, int value)

Unsafe version of isActive.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nsampleTimeback to summary
public static long nsampleTime(long struct)

Unsafe version of sampleTime.

nsampleTimeback to summary
public static void nsampleTime(long struct, long value)

Unsafe version of sampleTime.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

sampleTimeback to summary
public long sampleTime()

when in time the expression is expressed.

Annotations
@NativeType:XrTime
sampleTimeback to summary
public XrFacialExpressionsHTC sampleTime(long value)

Sets the specified value to the sampleTime field.

setback to summary
public XrFacialExpressionsHTC set(int type, long next, boolean isActive, long sampleTime, int expressionCount, FloatBuffer expressionWeightings)

Initializes this struct with the specified values.

setback to summary
public XrFacialExpressionsHTC set(XrFacialExpressionsHTC src)

Copies the specified struct data to this struct.

Parameters
src:XrFacialExpressionsHTC

the source struct

Returns:XrFacialExpressionsHTC

this struct

sizeofback to summary
public int sizeof()

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

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

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrFacialExpressionsHTC type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrFacialExpressionsHTC type$Default()

Sets the TYPE_FACIAL_EXPRESSIONS_HTC value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrFacialExpressionsHTC.Buffer

extends StructBuffer<XrFacialExpressionsHTC, XrFacialExpressionsHTC.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrFacialExpressionsHTC structs.

Field Summary

Modifier and TypeField and Description
private static final XrFacialExpressionsHTC

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrFacialExpressionsHTC.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 TypeMethod and Description
public int

Returns:

the value of the XrFacialExpressionsHTC#expressionCount field.
expressionCount
()

public XrFacialExpressionsHTC.Buffer
expressionCount(int value)

Sets the specified value to the XrFacialExpressionsHTC#expressionCount field.

public FloatBuffer

Returns:

a FloatBuffer view of the data pointed to by the XrFacialExpressionsHTC#expressionWeightings field.
expressionWeightings
(int
the number of elements in the returned buffer
capacity
)

public XrFacialExpressionsHTC.Buffer
expressionWeightings(FloatBuffer value)

Sets the address of the specified FloatBuffer to the XrFacialExpressionsHTC#expressionWeightings field.

protected XrFacialExpressionsHTC
public boolean

Returns:

the value of the XrFacialExpressionsHTC#isActive field.
isActive
()

public XrFacialExpressionsHTC.Buffer
isActive(boolean value)

Sets the specified value to the XrFacialExpressionsHTC#isActive field.

public long

Returns:

the value of the XrFacialExpressionsHTC#next field.
next
()

public XrFacialExpressionsHTC.Buffer
next(long value)

Sets the specified value to the XrFacialExpressionsHTC#next field.

public long

Returns:

the value of the XrFacialExpressionsHTC#sampleTime field.
sampleTime
()

public XrFacialExpressionsHTC.Buffer
sampleTime(long value)

Sets the specified value to the XrFacialExpressionsHTC#sampleTime field.

protected XrFacialExpressionsHTC.Buffer
public int

Returns:

the value of the XrFacialExpressionsHTC#type field.
type
()

public XrFacialExpressionsHTC.Buffer
type(int value)

Sets the specified value to the XrFacialExpressionsHTC#type field.

public XrFacialExpressionsHTC.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrFacialExpressionsHTC ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

Method Detail

expressionCountback to summary
public int expressionCount()
Returns:int

the value of the XrFacialExpressionsHTC#expressionCount field.

Annotations
@NativeType:uint32_t
expressionCountback to summary
public XrFacialExpressionsHTC.Buffer expressionCount(int value)

Sets the specified value to the XrFacialExpressionsHTC#expressionCount field.

expressionWeightingsback to summary
public FloatBuffer expressionWeightings(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:FloatBuffer

a FloatBuffer view of the data pointed to by the XrFacialExpressionsHTC#expressionWeightings field.

Annotations
@NativeType:float *
expressionWeightingsback to summary
public XrFacialExpressionsHTC.Buffer expressionWeightings(FloatBuffer value)

Sets the address of the specified FloatBuffer to the XrFacialExpressionsHTC#expressionWeightings field.

getElementFactoryback to summary
protected XrFacialExpressionsHTC getElementFactory()

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

Annotations
@Override
isActiveback to summary
public boolean isActive()
Returns:boolean

the value of the XrFacialExpressionsHTC#isActive field.

Annotations
@NativeType:XrBool32
isActiveback to summary
public XrFacialExpressionsHTC.Buffer isActive(boolean value)

Sets the specified value to the XrFacialExpressionsHTC#isActive field.

nextback to summary
public long next()
Returns:long

the value of the XrFacialExpressionsHTC#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrFacialExpressionsHTC.Buffer next(long value)

Sets the specified value to the XrFacialExpressionsHTC#next field.

sampleTimeback to summary
public long sampleTime()
Returns:long

the value of the XrFacialExpressionsHTC#sampleTime field.

Annotations
@NativeType:XrTime
sampleTimeback to summary
public XrFacialExpressionsHTC.Buffer sampleTime(long value)

Sets the specified value to the XrFacialExpressionsHTC#sampleTime field.

selfback to summary
protected XrFacialExpressionsHTC.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrFacialExpressionsHTC#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrFacialExpressionsHTC.Buffer type(int value)

Sets the specified value to the XrFacialExpressionsHTC#type field.

type$Defaultback to summary
public XrFacialExpressionsHTC.Buffer type$Default()

Sets the TYPE_FACIAL_EXPRESSIONS_HTC value to the XrFacialExpressionsHTC#type field.