C Specification

The xrUpdateSoundFieldConfigBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrUpdateSoundFieldConfigBD(
    XrSoundFieldBD                              soundField,
    const XrSoundFieldConfigBD*                 config,
    XrSoundFieldFlagsBD                         flags);

Description

When updating the configuration of a submitted sound field, applications set flags to specify which properties to update. The runtime must not update a property if the corresponding flag bit is not set. The runtime must not read the parameters of XrSoundFieldConfigBD if the corresponding bits are not set; this means that the application may pass invalid or uninitialized fields for parameters it does not intend to update.

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_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_POSE_INVALID

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_BD_spatial_audio_rendering, XrSoundFieldBD, XrSoundFieldConfigBD, XrSoundFieldFlagsBD

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-2026 The Khronos Group Inc.

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