C Specification

The XrSoundFieldConfigBD structure is defined as:

// Provided by XR_BD_spatial_audio_rendering
typedef struct XrSoundFieldConfigBD {
     XrStructureType    type;
    const void*         next;
    XrBool32            enabled;
    XrQuaternionf       orientation;
    XrSpace             baseSpace;
    float               mainVolume;
    float               lfeGain;
} XrSoundFieldConfigBD;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain.

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

  • orientation is the XrQuaternionf of the sound field. It defines the orientation of the sound field in the baseSpace.

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

  • mainVolume is the main volume of the sound field. It acts as a linear gain attenuation of the input signal in the range (0, 1).

  • lfeGain is the LFE (low-frequency effects) gain of the sound field. It acts as a linear gain attenuation of the input signal in the range (0, 1) on top of the main volume.

Description

The behavior below specifies how the runtime renders audio when tracking quality changes for the baseSpace.

  • While the baseSpace pose is valid, but not tracked (i.e. xrLocateSpace reports its location with XR_SPACE_LOCATION_POSITION_VALID_BIT and XR_SPACE_LOCATION_ORIENTATION_VALID_BIT set, but not XR_SPACE_LOCATION_POSITION_TRACKED_BIT and XR_VIEW_STATE_POSITION_TRACKED_BIT), the runtime must keep rendering the sound field using the most recent valid pose of that space.

  • While the baseSpace pose is neither valid nor tracked (i.e. xrLocateSpace reports its location with either XR_SPACE_LOCATION_POSITION_VALID_BIT or XR_SPACE_LOCATION_ORIENTATION_VALID_BIT unset), the runtime should keep rendering the sound field using the most recent valid position and orientation of that space relative to its parent.

Valid Usage (Implicit)

See Also

XR_BD_spatial_audio_rendering, XrBool32, XrQuaternionf, XrSpace, XrStructureType, xrCreateSoundFieldBD, xrUpdateSoundFieldConfigBD

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.