C Specification

The xrGetFaceCalibrationStateANDROID function is defined as:

// Provided by XR_ANDROID_face_tracking
XrResult xrGetFaceCalibrationStateANDROID(
    XrFaceTrackerANDROID                        faceTracker,
    XrBool32*                                   faceIsCalibratedOutput);

Parameters

Parameter Descriptions

Description

An application checks the face calibration state by calling the xrGetFaceCalibrationStateANDROID function.

When the tracking service is still under initialization, the runtime may return XR_ERROR_SERVICE_NOT_READY_ANDROID from xrGetFaceCalibrationStateANDROID to indicate that the application can retry later.

If the system does not support face calibration, the runtime must return XR_ERROR_FEATURE_UNSUPPORTED from xrGetFaceCalibrationStateANDROID. Otherwise, the runtime may set faceIsCalibratedOutput to XR_TRUE to reflect the face calibration state.

Valid Usage (Implicit)
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

See Also

XR_ANDROID_face_tracking, XrBool32, 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.