AXFXReverbHiInit

Syntax

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

BOOL AXFXReverbHiInit(AXFX_REVERBHI *reverb);

Parameters

reverb Pointer to an AXFX_REVERBHI structure with configured user parameters.

Return Values

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

Description

The AXFXReverbHiInit function initializes High-Quality Reverb (= AXFX_REVERBHI) based on user parameters in the AXFX_REVERBHI structure. This function also allocates and initializes the memory used by the delay line and similar processing steps. The user must configure the AXFX_REVERBHI structure's user parameters prior to calling this function.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_REVERBHI

Revision History

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


CONFIDENTIAL