xrDestroySoundObstacleBD(3)

C Specification

The xrDestroySoundObstacleBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrDestroySoundObstacleBD(
    XrSoundObstacleBD                           soundObstacle);

Parameter Descriptions

Applications use this function to remove a submitted sound obstacle.

To temporarily disable an obstacle, set the respective XrSoundObstacleConfigBD::enabled to XR_FALSE instead with a call to xrUpdateSoundObstacleConfigBD.

Valid Usage (Implicit)

The XR_BD_spatial_audio_rendering extension must be enabled prior to calling xrDestroySoundObstacleBD
soundObstacle must be a valid XrSoundObstacleBD handle

Thread Safety

Access to soundObstacle, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

On failure, this command returns

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.