AXFXDelayExpSettingsUpdate

C Specification

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

BOOL AXFXDelayExpSettingsUpdate (AXFX_DELAY_EXP *delay);

Arguments

delay Pointer to an initialized AXFX_DELAY_EXP structure.

Return Values

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

Description

The AXFXDelayExpSettingsUpdate function is used when changing parameters of the initialized Delay Expansion (= AXFX_DELAY_EXP structure). When this function is called, the current Delay Expansion is shut down and then reinitialized based on new user parameters. Memory is not freed and re-allocated during this process.

Caution is required when using this function to change the AXFX_DELAY_EXP structure's user parameter delay. Because memory is not freed and re-allocated, delay cannot be changed to a value greater than maxDelay. If it is necessary to change maxDelay, use the AXFXDelayExpSettings function.

Revision History

2007/08/10 Initial version.