C Specification

The xrCreateFaceTrackerBD function is defined as:

// Provided by XR_BD_facial_simulation
XrResult xrCreateFaceTrackerBD(
    XrSession                                   session,
    const XrFaceTrackerCreateInfoBD*            createInfo,
    XrFaceTrackerBD*                            tracker);

Parameters

Parameter Descriptions

Description

An application can create an XrFaceTrackerBD handle by calling the xrCreateFaceTrackerBD function, specifying a supported mode from those defined in XrFacialSimulationModeBD.

If the runtime does not support the specified mode provided in createInfo in XrFaceTrackerCreateInfoBD, the runtime must return XR_ERROR_FEATURE_UNSUPPORTED from xrCreateFaceTrackerBD. An application can get supported modes by calling the xrEnumerateFacialSimulationModesBD function.

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

  • XR_ERROR_PERMISSION_INSUFFICIENT

  • XR_ERROR_FEATURE_UNSUPPORTED

See Also

XR_BD_facial_simulation, XrFaceTrackerBD, XrFaceTrackerCreateInfoBD, XrSession

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.