AXFXReverbStdExpSettingsUpdate

Syntax

#include <revolution.h>
#include <revolution/axfx.h>

BOOL AXFXReverbStdExpSettingsUpdate (AXFX_REVERBSTD_EXP *reverb);

Arguments

reverb Pointer to an initialized AXFX_REVERBSTD_EXP structure.

Return Values

TRUE if successful; FALSE if a parameter is out of bounds or if memory allocation fails.

Description

The AXFXReverbStdExpSettingsUpdate function is used when changing parameters of the initialized Standard Reverb Expansion (= AXFX_REVERBSTD_EXP structure). When this function is called, the current Standard Reverb Expansion is shut down and then reinitialized based on new user parameters. Memory is not freed and re-allocated during this process.

Caution is required when using this function to change the AXFX_REVERBSTD_EXP structure's user parameter preDelayTime. Because memory is not freed and re-allocated, preDelayTime cannot be changed to a value greater than preDelayTimeMax. If it is necessary to change preDelayTimeMax, use the AXFXReverbStdExpSettings function.

See Also

AXFX_REVERBSTD_EXP, AXFXReverbStdExpSettings

Revision History

2007/08/10 Initial version.

CONFIDENTIAL