AXFXDelayInit

Syntax

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

BOOL AXFXDelayInit (AXFX_DELAY *delay);

Parameters

delay Pointer to an AXFX_DELAY structure with configured user parameters.

Return Values

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

Description

The AXFXDelayInit function initializes Delay (= AXFX_DELAY) based on user parameters in the AXFX_DELAY structure. This function also allocates and initializes the memory used by the delay line and similar processing steps. User must configure the AXFX_DELAY 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_DELAY

Revision History

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


CONFIDENTIAL