C Specification

The xrUpdateSoundObstacleMaterialConfigBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrUpdateSoundObstacleMaterialConfigBD(
    XrSoundObstacleMaterialBD                   material,
    const XrSoundObstacleMaterialConfigBD*      config);

Parameters

Parameter Descriptions

Description

This function can be used to update the configuration of a created XrSoundObstacleMaterialBD.

Note that a successful update of an XrSoundObstacleMaterialBD on its own does not affect the virtual sound propagation, until the updated XrSoundObstacleMaterialBD is used to create or update sound obstacles using xrCreateSoundObstacleBD or xrUpdateSoundObstacleConfigBD. This is true even if XrSoundObstacleMaterialBD was referenced by an active sound obstacle.

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_LIMIT_REACHED

  • XR_ERROR_OUT_OF_MEMORY

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_BD_spatial_audio_rendering, XrSoundObstacleMaterialBD, XrSoundObstacleMaterialConfigBD

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.