AXFXDelayInit

C Specification

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

BOOL AXFXDelayInit (AXFX_DELAY *delay);

Arguments

delay Pointer to an AXFX_DELAY structure with configured user parameters.

Return Values

TRUE if successful; FALSE if a parameter is out of bounds or the 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.

See Also

AXFX_DELAY

Revision History

2007/08/09 Standardized notation.
2006/03/01 Initial version.


CONFIDENTIAL