C Specification

The XrSoundObstacleConfigBD structure is defined as:

// Provided by XR_BD_spatial_audio_rendering
typedef struct XrSoundObstacleConfigBD {
    XrStructureType               type;
    const void*                   next;
    XrBool32                      enabled;
    XrPosef                       pose;
    XrSpace                       baseSpace;
    uint32_t                      materialCount;
    XrSoundObstacleMaterialBD*    materials;
} XrSoundObstacleConfigBD;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

  • enabled is an XrBool32, indicating whether the sound obstacle is enabled.

  • pose is an XrPosef of the acoustic mesh.

  • baseSpace is an XrSpace which the pose is defined in.

  • materialCount is the number of materials in the materials array.

  • materials is an array of materialCount XrSoundObstacleMaterialBD that defines the material properties for each vertex of the sound obstacle.

Description

Applications use XrSoundObstacleConfigBD to configure an XrSoundObstacleBD.

If this config is used to create an XrSoundObstacleBD, materialCount must be equal to the associated XrSoundTriangleMeshBD::vertexCount, otherwise the runtime must return XR_ERROR_VALIDATION_FAILURE.

If this config is used to update both shape and materials of an existing XrSoundObstacleBD, materialCount must be equal to the associated XrSoundTriangleMeshBD::vertexCount, otherwise the runtime must return XR_ERROR_VALIDATION_FAILURE.

If this config is used to update only materials of an existing XrSoundObstacleBD, materialCount must be equal to the vertices count of this XrSoundTriangleMeshBD, otherwise the runtime must return XR_ERROR_VALIDATION_FAILURE.

The runtime must not use the sound obstacle for sound calculations if enabled is set to XR_FALSE.

Valid Usage (Implicit)

See Also

XR_BD_spatial_audio_rendering, XrBool32, XrPosef, XrSoundObstacleMaterialBD, XrSpace, XrStructureType, xrCreateSoundObstacleBD, xrUpdateSoundObstacleConfigBD

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.