AXFXReverbHiInitDpl2 DEPRECATED

Syntax

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

BOOL AXFXReverbHiInitDpl2 (AXFX_REVERBHI_DPL2 *reverb);

Parameters

reverb Pointer to an AXFX_REVERBHI_DPL2 structure with configured user parameters.

Return Values

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

Description

The AXFXReverbHiInitDpl2 function initializes the Dolby Pro Logic II (DPL2) version of High-Quality Reverb (= AXFX_REVERBHI_DPL2) based on the user parameters in the AXFX_REVERBHI_DPL2 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_DPL2 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

Deprecated Do not call this function in new code.

See Also

AXFX_REVERBHI_DPL2

Revision History

2013/05/08 Automated cleanup pass.
2007/10/05 Corrected an error in the description of the arguments.
2007/08/08 Standardized notation.
2006/03/01 Initial version.


CONFIDENTIAL