donut::audio::SoundStageOptions Struct Reference

Configuration options for a SoundStage. More...

#include <donut/audio/SoundStage.hpp>

Public Attributes
float	volume = 1.0f
	Global master volume. More...
float	speedOfSound = 343.3f
	The speed of sound in the sound stage. More...
unsigned	maxSimultaneousSounds = 32u
	The maximum total number of sound instances that can play simultaneously. More...

Detailed Description

Configuration options for a SoundStage.

Member Data Documentation

volume

float donut::audio::SoundStageOptions::volume = 1.0f

Global master volume.

The amplitude of all playing sound is multiplied by this gain value, meaning that a value of 1 represents no change, i.e. 100% of the original volume.

speedOfSound

float donut::audio::SoundStageOptions::speedOfSound = 343.3f

The speed of sound in the sound stage.

This value is used for doppler effect calculations and distance delay simulation.

Note

The default value assumes that any coordinates passed to the sound stage are expressed in meters, and that the sound stage environment is dry air at around 20 degrees Celsius.

maxSimultaneousSounds

unsigned donut::audio::SoundStageOptions::maxSimultaneousSounds = 32u

The maximum total number of sound instances that can play simultaneously.

If the number of playing sounds exceeds this number, the ones with the highest volume will be picked to actually play.

---

The documentation for this struct was generated from the following file:

• include/donut/audio/SoundStage.hpp