xrGetFaceStateANDROID(3)

C Specification

The xrGetFaceStateANDROID function returns blend shapes of facial expressions at a given time.

// Provided by XR_ANDROID_face_tracking
XrResult xrGetFaceStateANDROID(
    XrFaceTrackerANDROID                        faceTracker,
    const XrFaceStateGetInfoANDROID*            getInfo,
    XrFaceStateANDROID*                         faceStateOutput);

Parameters

Parameter Descriptions

faceTracker is an XrFaceTrackerANDROID previously created by xrCreateFaceTrackerANDROID.
getInfo is a pointer to XrFaceStateGetInfoANDROID describing information to obtain face expressions.
faceStateOutput is a pointer to XrFaceStateANDROID receiving the returned face tracking state and facial expressions.

Description

Valid Usage (Implicit)

The XR_ANDROID_face_tracking extension must be enabled prior to calling xrGetFaceStateANDROID
faceTracker must be a valid XrFaceTrackerANDROID handle
getInfo must be a pointer to a valid XrFaceStateGetInfoANDROID structure
faceStateOutput must be a pointer to an XrFaceStateANDROID structure

Return Codes

On success, this command returns

XR_SUCCESS
XR_SESSION_LOSS_PENDING

On failure, this command returns

XR_ERROR_FUNCTION_UNSUPPORTED
XR_ERROR_VALIDATION_FAILURE
XR_ERROR_RUNTIME_FAILURE
XR_ERROR_HANDLE_INVALID
XR_ERROR_INSTANCE_LOST
XR_ERROR_SESSION_LOST
XR_ERROR_OUT_OF_MEMORY
XR_ERROR_LIMIT_REACHED
XR_ERROR_SIZE_INSUFFICIENT
XR_ERROR_TIME_INVALID
XR_ERROR_SERVICE_NOT_READY_ANDROID

See Also

XR_ANDROID_face_tracking, XrFaceStateANDROID, XrFaceStateGetInfoANDROID, XrFaceTrackerANDROID

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2025 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.