AXFXDelaySettings

Syntax

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

BOOL AXFXDelaySettings (AXFX_DELAY *delay);

Parameters

delay Pointer to an initialized AXFX_DELAY structure.

Return Values

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

Description

The AXFXDelaySettings function is used when changing parameters of an initialized Delay (= AXFX_DELAY structure). When this function is called, current Delay is shut down and the memory that was allocated to it at initialization is freed. This function then reinitializes Delay based on new user parameters.

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/08/09 Standardized notation.
2006/03/01 Initial version.


CONFIDENTIAL