xrEnumerateFacialSimulationModesBD(3)

C Specification

The xrEnumerateFacialSimulationModesBD function is defined as:

// Provided by XR_BD_facial_simulation
XrResult xrEnumerateFacialSimulationModesBD(
    XrSession                                   session,
    uint32_t                                    modeCapacityInput,
    uint32_t*                                   modeCountOutput,
    XrFacialSimulationModeBD*                   modes);

Parameters

Parameter Descriptions

session is an XrSession previously created with flinl:xrCreateSession.
modeCapacityInput is the capacity of the modes array, or 0 to retrieve the required capacity.
modeCountOutput is a pointer to the count of modes written, or a pointer to the required capacity in the case that modeCapacityInput is insufficient.
modes is a pointer to an array of XrFacialSimulationModeBD values, but can be NULL if modeCapacityInput is 0.
See the https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#fundamentals-buffer-size-parameters section for a detailed description of retrieving the required modes size.

Description

Valid Usage (Implicit)

The XR_BD_facial_simulation extension must be enabled prior to calling xrEnumerateFacialSimulationModesBD
session must be a valid XrSession handle
modeCountOutput must be a pointer to a uint32_t value
If modeCapacityInput is not 0, modes must be a pointer to an array of modeCapacityInput XrFacialSimulationModeBD values

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_SIZE_INSUFFICIENT

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

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

xrEnumerateFacialSimulationModesBD(3) Manual Page

Name

C Specification

Parameters

Description

See Also

Document Notes

Copyright