Module containing common structures and common definition that are used mostly by the sound fx subsystem, SoundSource as well as EnergyField.

See Also

Sfx, SoundSource, EnergyField, Curve

EffectSlot

Constant flags definition of the available effect slots.

DistanceModel

Definitions of the available attenuation algorithms used by SoundSource and EnergyField.

kNoDistanceAttenuation: No attenuation calculation will be applied and a value of 1 will always be used.
kLinearDistance: Linear distance interpolation.
kLinearDistanceClamped: Linear distance interpolation clamped to the range of 0 to 1.
kInverseDistance: Same as kLinearDistance except that range is inverted (from 1 to x).
kInverseDistanceClamped: Same as above at the exception that the range is clamped.
kExponentDistance: The linear interpolation received an exponential gain.
kExponentDistanceClamped: Sample as above but clamped to the range of 0 to 1.
kInverseExponentDistance: Same as kExponentDistance but reversed.
kInverseExponentDistanceClamped: Same as above but lamped to the range of 0 to 1.
kDefaultAttenuation: Specify that the default attenuation model of the parent resource should be used.
kCustomCurve: Allows you to specify a custom attenuation Curve.

Configurable parameters of the Sound FX subsystem.

Warning: Take note that changing any of the parameters below require the sound subsystem to be restarted.

Name	Description
`frequency`	Specify the output of the audio mixer frequency in Mhz.
Declaration unsigned int frequency Range 8000 Mhz to 96000 Mhz Note Usually a value of 44000 Mhz or 48000 Mhz is suitable for most application and provide a realtively acceptable sound quality.
`stereo_sources`	Maximum amount of stereo sound sources that can be played simultaneously.
Declaration unsigned int stereo_sources Range 0 to 4 Note A value of 1 or 2 is actually recommended for most application.
`auxiliary_sends`	Maximum amount of auxiliary sends.
Declaration unsigned int auxiliary_sends Range 0 to 8 Note A value of 4 is used by most application.
`hrtf`	Enable or disable head-related transfer function.
Declaration bool hrtf Note Enabling this functionality is mostly audible by headphones more than speakers. However, keeping it enabling to increase the audio output quality.

Settingsurable parameters of the Sound FX subsystem.

Name	Description
`distance_model`	The default DistanceModel to apply for all SoundSource attenuation calculation.
Declaration DistanceModel distance_model Note That each SoundSource might choose to adopt a separate model which have to be set on a per source basis.
`source_model`	Force the sound system to use a per SoundSource attenuation distance model only.
Declaration bool source_model
`speed_of_sound`	Controls the default speed of sound specified in meters per seconds.
Declaration float speed_of_sound Note A default value of 343.3 meters per second is usually suitable for most application assuming that 1 meter equals to 1 unit.
`doppler_factor`	Specify the scale factor between the SoundSource and the Listener velocity.
Declaration float doppler_factor
`doppler_velocity`	Determine the multiplier to apply to the speed of sound.
Declaration float doppler_velocity