DemoGL::Reference::Functions::DEMOGL_SoundSystemSetEAXEnv

DEMOGL_SoundSystemSetEAXEnv

DEMOGL_SoundSystemSet3DFactors sets the overall system EAX environment settings which will affect all currently playing channels.

int
DEMOGL_SoundSystemSetEAXEnv(
	const int iEAXEnvironment, 
	const float fReverbVolume, 
	const float fDecay, 
	const float fDamp
);
	
Parameters.
iEAXEnvironment
Specifies the EAX environment setting to use. This parameter is equal to one of the predefined environments for EAX soundcards. Legal values for iEAXEnvironment are:
EAX_ENVIRONMENT_GENERIC, EAX_ENVIRONMENT_PADDEDCELL, EAX_ENVIRONMENT_ROOM, EAX_ENVIRONMENT_BATHROOM, EAX_ENVIRONMENT_LIVINGROOM, EAX_ENVIRONMENT_STONEROOM, EAX_ENVIRONMENT_AUDITORIUM, EAX_ENVIRONMENT_CONCERTHALL, EAX_ENVIRONMENT_CAVE, EAX_ENVIRONMENT_ARENA, EAX_ENVIRONMENT_HANGAR, EAX_ENVIRONMENT_CARPETEDHALLWAY, EAX_ENVIRONMENT_HALLWAY, EAX_ENVIRONMENT_STONECORRIDOR, EAX_ENVIRONMENT_ALLEY, EAX_ENVIRONMENT_FOREST, EAX_ENVIRONMENT_CITY, EAX_ENVIRONMENT_MOUNTAINS, EAX_ENVIRONMENT_QUARRY, EAX_ENVIRONMENT_PLAIN, EAX_ENVIRONMENT_PARKINGLOT, EAX_ENVIRONMENT_SEWERPIPE, EAX_ENVIRONMENT_UNDERWATER, EAX_ENVIRONMENT_DRUGGED, EAX_ENVIRONMENT_DIZZY, EAX_ENVIRONMENT_PSYCHOTIC.

These values are defined in the include file DemoGL_Bass.h which is included in the DemoGL SDK.

fReverbVolume
Specifies the volume of the reverb, i.e. the amount of reverb. Values for fReverbVolume have to fall in the range [0.0, 1.0], with 0.0 is no reverb and 1.0 is maximum reverb. Specifying a value < 0.0 leaves the current value for fReverbVolume untouched.
fDecay
Specifies the time in seconds it takes the reverb to diminish by 60dB. Values have to fall in the range [0.1, 20.0], with 0.1 is minimum value and 20.0 is the maximum value. Specifying a value < 0.0 leaves the current value for fDecay untouched.
fDamp
Specifies the damping of the sound, which frequency area should decay faster: higher or lower frequencies. Legal values for fDamp are: 0.0: high frequencies decay quickest, 1.0: low/high frequencies decay equally, 2.0: low frequencies decay quickest. Specifying a value < 0.0 leaves the current value for fDamp untouched.

Return values.
If the function succeeds, it returns SYS_OK.
If the function fails, it returns SYS_NOK.

Remarks.
Include DemoGL_Bass.h to use the predefined EAX environment flags. Calling this function affects all currently playing channels and only those who play sound owned by elements which are loaded with 3D enabled. When the user does not select EAX in the startup dialog, or doesn't own an EAX compatible sound card, this function doesn't have any effect.

Example.

Requirements.
DemoGL v1.3 (build 0112 or higher)

See also.

Last changed on 18-jan-2001

©1999-2001 Solutions Design