AXFXReverbStdExpSettings

Syntax

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

BOOL AXFXReverbStdExpSettings (AXFX_REVERBSTD_EXP *reverb);

Parameters

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 AXFXReverbStdExpSettings 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 the memory that was allocated to it at initialization is freed. This function then reinitializes the Standard Reverb Expansion based on new user parameters.

The use of this function is required when changing the AXFX_REVERBSTD_EXP structure's user parameter preDelayTimeMax.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_REVERBSTD_EXP

Revision History

2013/05/08 Automated cleanup pass.
2007/08/10 Initial version.


CONFIDENTIAL