C Specification

The XrFacialSimulationModeBD enumeration describes the modes of facial simulation and tracking.

// Provided by XR_BD_facial_simulation
typedef enum XrFacialSimulationModeBD {
    XR_FACIAL_SIMULATION_MODE_DEFAULT_BD = 0,
    XR_FACIAL_SIMULATION_MODE_COMBINED_AUDIO_BD = 1,
    XR_FACIAL_SIMULATION_MODE_COMBINED_AUDIO_WITH_LIP_BD = 2,
    XR_FACIAL_SIMULATION_MODE_ONLY_AUDIO_WITH_LIP_BD = 3,
    XR_FACIAL_SIMULATION_MODE_MAX_ENUM_BD = 0x7FFFFFFF
} XrFacialSimulationModeBD;

Description

Enumerant Descriptions

  • XR_FACIAL_SIMULATION_MODE_DEFAULT_BD  — When calling xrGetFacialSimulationDataBD, the output contains the XrFacialSimulationDataBD only.

  • XR_FACIAL_SIMULATION_MODE_COMBINED_AUDIO_BD  — Results in the same output as the Default mode, furthermore, runtime can provide a precise result by using the audio input.

  • XR_FACIAL_SIMULATION_MODE_COMBINED_AUDIO_WITH_LIP_BD  — Separates the result into two parts, one is XrFacialSimulationDataBD, the other is XrLipExpressionDataBD.

  • XR_FACIAL_SIMULATION_MODE_ONLY_AUDIO_WITH_LIP_BD  — Uses only audio input to produce the output result as XrLipExpressionDataBD.

When using XR_FACIAL_SIMULATION_MODE_DEFAULT_BD and XR_FACIAL_SIMULATION_MODE_COMBINED_AUDIO_BD, only XrFacialSimulationDataBD is populated in the output.

When using XR_FACIAL_SIMULATION_MODE_COMBINED_AUDIO_WITH_LIP_BD the application must chain an XrLipExpressionDataBD to XrFacialSimulationDataBD::next when calling xrGetFacialSimulationDataBD.

When using XR_FACIAL_SIMULATION_MODE_ONLY_AUDIO_WITH_LIP_BD the runtime may generate predicted animations in face expression in XrFacialSimulationDataBD and XrLipExpressionDataBD structures when calling xrGetFacialSimulationDataBD, to make the avatar look more natural.

See Also

XR_BD_facial_simulation, XrFaceTrackerCreateInfoBD, xrEnumerateFacialSimulationModesBD, xrGetFacialSimulationModeBD, xrSetFacialSimulationModeBD

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.