Previous Topic Index Next Topic
[API function]

FSOUND_Reverb_GetEnvironmentAdvanced

Returns the current EAX reverb environment.

signed char F_API FSOUND_Reverb_GetEnvironmentAdvanced(
int *env,
int *Room,
int *RoomHF,
float *RoomRolloffFactor,
float *DecayTime,
float *DecayHFRatio,
int *Reflections,
float *ReflectionsDelay,
int *Reverb,
float *ReverbDelay,
float *EnvironmentSize,
float *EnvironmentDiffusion,
float *AirAbsorptionHF
);

Parameters

env The environment type. see FSOUND_REVERB_ENVIRONMENTS for types
This can be NULL to ignore it.
Room Room effect level at low frequencies -10000 to 0 default: -10000 mB
This can be NULL to ignore it.
RoomHF Room effect high-frequency level re. low frequency level -10000 to 0 default: 0 mB
This can be NULL to ignore it.
RoomRolloffFactor Like DS3D flRolloffFactor but for room effect 0.0 to 10.0 default: 0.0
This can be NULL to ignore it.
DecayTime Reverberation decay time at low frequencies 0.1 to 20.0 default: 1.0 s
This can be NULL to ignore it.
DecayHFRatio High-frequency to low-frequency decay time ratio 0.1 to 2.0 default: 0.5
This can be NULL to ignore it.
Reflections Early reflections level relative to room effect -10000 to 1000 default: -10000 mB
This can be NULL to ignore it.
ReflectionsDelay Initial reflection delay time 0.0 to 0.3 default: 0.02 s
This can be NULL to ignore it.
Reverb Late reverberation level relative to room effect -10000 to 2000 default: -10000 mB
This can be NULL to ignore it.
ReverbDelay Late reverberation delay time relative to initial reflection 0.0 to 0.1 default: 0.04 s
This can be NULL to ignore it.
EnvironmentSize Environment size in meters 0.0 to 100.0 default: 100.0
This can be NULL to ignore it.
EnvironmentDiffusion Environment diffusion 0.0 to 100.0 default: 100.0
This can be NULL to ignore it.
AirAbsorptionHF Change in level per meter at 5 kHz 20.0 to 20000.0 default: 5000.0 Hz
This can be NULL to ignore it.

Return Value

On success, TRUE is returned.
On failure, FALSE is returned.

Remarks

These values are only relevant if you are in DSOUND mode with an EAX2 compatible soundcard,
or using A3D3.0.

See Also

FSOUND_REVERB_ENVIRONMENTS , FSOUND_Reverb_SetEnvironment , FSOUND_Reverb_SetEnvironmentAdvanced

This document copyright ©Firelight Multimedia, 1999-2001. All rights reserved.
Generated Thu Sep 13 00:18:09 2001 by SourceDoc v0.10, the automated source code documenter.