C Specification

The xrCreateSoundObstacleMaterialBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrCreateSoundObstacleMaterialBD(
    XrSpatialAudioRendererBD                    renderer,
    const XrSoundObstacleMaterialConfigBD*      config,
    XrSoundObstacleMaterialBD*                  material);

Parameters

Parameter Descriptions

Description

A valid XrSoundObstacleMaterialBD handle can be used to configure the material properties of the sound obstacle when creating or updating a sound obstacle.

Note that a successful creation of an XrSoundObstacleMaterialBD on its own does not affect the virtual sound propagation, until the created XrSoundObstacleMaterialBD is used to create or update sound obstacles using xrCreateSoundObstacleBD or xrUpdateSoundObstacleConfigBD.

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, XrSpatialAudioRendererBD

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.