AXFXReverbStdSettings

Syntax

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

BOOL AXFXReverbStdSettings (AXFX_REVERBSTD *reverb);

Parameters

reverb Pointer to an initialized AXFX_REVERBSTD structure.

Return Values

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

Description

The AXFXReverbStdSettings function is used when changing parameters of the initialized Standard Reverb (= AXFX_REVERBSTD structure). When this function is called, the current Standard Reverb is shut down and the memory that was allocated to it at initialization is freed. This function then reinitializes Standard Reverb based on new user parameters.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_REVERBSTD

Revision History

2013-05-08 Automated cleanup pass.
2007-08-09 Standardized notation.
2006-03-01 Initial version.


CONFIDENTIAL