C Specification

The xrUpdateSoundObstacleConfigBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrUpdateSoundObstacleConfigBD(
    XrSoundObstacleBD                           soundObstacle,
    const XrSoundObstacleConfigBD*              config,
    const XrSoundTriangleMeshBD*                mesh,
    XrSoundObstacleFlagsBD                      flags);

Parameters

Parameter Descriptions

  • soundObstacle is the XrSoundObstacleBD to be updated.

  • config is the XrSoundObstacleConfigBD that defines the configuration of the sound obstacle, including pose and material information.

  • mesh is the XrSoundTriangleMeshBD that describes the shape of the sound obstacle.

  • flags is the bit mask (bitwise OR of XrSoundObstacleFlagsBD) of the sound obstacle properties to change, including pose and material information.

Description

When updating the configuration of a submitted sound obstacle, applications use 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 XrSoundObstacleConfigBD 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.

If XR_SOUND_OBSTACLE_MESH_BIT_BD is set in flags, mesh must not be NULL, otherwise, the runtime must return XR_ERROR_VALIDATION_FAILURE.

If any other bit is set, config must not be NULL, otherwise, the runtime must return XR_ERROR_VALIDATION_FAILURE.

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, XrSoundObstacleBD, XrSoundObstacleConfigBD, XrSoundObstacleFlagsBD, XrSoundTriangleMeshBD

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.