SFXEnvironment

Description of a reverb environment.

Inherit:

SimDataBlock

Description

A reverb environment specifies how the audio mixer should render advanced environmental audio effects.

To use reverb environments in your level, set up one or more ambient audio spaces, assign reverb environments appropriately, and then attach the SFXAmbiences to your LevelInfo (taking effect globally) or Zone objects (taking effect locally).

To define your own custom reverb environments, it is usually easiest to adapt one of the pre-existing reverb definitions:

singleton SFXEnvironment( AudioEnvCustomUnderwater : AudioEnvUnderwater )
{
   // Override select properties from AudioEnvUnderwater here.
};

In the Datablock Editor, this can be done by selecting an existing environment to copy from when creating the SFXEnvironment datablock.

For a precise description of reverb audio and the properties of this class, please consult the EAX documentation.

All SFXEnvironment instances are automatically added to the global SFXEnvironmentSet.

Fields

float SFXEnvironment::airAbsorptionHF

Change in level per meter at high frequencies.

float SFXEnvironment::decayHFRatio

High-frequency to mid-frequency decay time ratio.

float SFXEnvironment::decayLFRatio

Low-frequency to mid-frequency decay time ratio.

float SFXEnvironment::decayTime

Reverberation decay time at mid frequencies.

float SFXEnvironment::density

Value that controls the modal density in the late reverberation decay.

float SFXEnvironment::diffusion

Value that controls the echo density in the late reverberation decay.

float SFXEnvironment::echoDepth

Echo depth.

float SFXEnvironment::echoTime

Echo time.

float SFXEnvironment::envDiffusion

Environment diffusion.

float SFXEnvironment::envSize

Environment size in meters.

int SFXEnvironment::flags

A bitfield of reverb flags.

float SFXEnvironment::HFReference

Reference high frequency in Hertz.

float SFXEnvironment::LFReference

Reference low frequency in Hertz.

float SFXEnvironment::modulationDepth

Modulation depth.

float SFXEnvironment::modulationTime

Modulation time.

int SFXEnvironment::reflections

Early reflections level relative to room effect.

float SFXEnvironment::reflectionsDelay

Initial reflection delay time.

float SFXEnvironment::reflectionsPan[3]

Early reflections panning vector.

int SFXEnvironment::reverb

Late reverberation level relative to room effect.

const int SFXEnvironment::REVERB_CORE0[static]

PS2 Only - Reverb is applied to CORE0 (hw voices 0-23).

const int SFXEnvironment::REVERB_CORE1[static]

PS2 Only - Reverb is applied to CORE1 (hw voices 24-47).

const int SFXEnvironment::REVERB_DECAYHFLIMIT[static]

SFXEnvironment::airAbsorptionHF affects SFXEnvironment::decayHFRatio .

const int SFXEnvironment::REVERB_DECAYTIMESCALE[static]

SFXEnvironment::envSize affects reverberation decay time.

const int SFXEnvironment::REVERB_ECHOTIMESCALE[static]

SFXEnvironment::envSize affects echo time.

const int SFXEnvironment::REVERB_HIGHQUALITYDPL2REVERB[static]

GameCube/Wii Only - Use high-quality DPL2 reverb.

const int SFXEnvironment::REVERB_HIGHQUALITYREVERB[static]

GameCube/Wii Only - Use high-quality reverb.

const int SFXEnvironment::REVERB_MODULATIONTIMESCALE[static]

SFXEnvironment::envSize affects modulation time.

const int SFXEnvironment::REVERB_REFLECTIONSDELAYSCALE[static]

SFXEnvironment::envSize affects initial reflection delay time.

const int SFXEnvironment::REVERB_REFLECTIONSSCALE[static]

SFXEnvironment::envSize affects reflection level.

const int SFXEnvironment::REVERB_REVERBDELAYSCALE[static]

SFXEnvironment::envSize affects late reverberation delay time.

const int SFXEnvironment::REVERB_REVERBSCALE[static]

SFXEnvironment::envSize affects reflections level.

float SFXEnvironment::reverbDelay

Late reverberation delay time relative to initial reflection.

float SFXEnvironment::reverbPan[3]

Late reverberation panning vector.

int SFXEnvironment::room

Room effect level at mid-frequencies.

int SFXEnvironment::roomHF

Relative room effect level at high frequencies.

int SFXEnvironment::roomLF

Relative room effect level at low frequencies.

float SFXEnvironment::roomRolloffFactor

Logarithmic distance attenuation rolloff scale factor for reverb room size effect.