AXFXChorusExpInit

Syntax

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

BOOL AXFXChorusExpInit (AXFX_CHORUS_EXP *chorus);

Parameters

chorus Pointer to an AXFX_CHORUS_EXP structure with configured user parameters.

Return Values

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

Description

The AXFXChorusExpInit function initializes the Chorus Expansion (= AXFX_CHORUS_EXP) based on user parameters in the AXFX_CHORUS_EXP structure. This function also allocates and initializes the memory used by the delay line and similar processing steps. The user must configure the AXFX_CHORUS_EXP 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_CHORUS_EXP

Revision History

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


CONFIDENTIAL