AXFX2OverdriveSettingsUpdate

Syntax

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

BOOL AXFX2OverdriveSettingsUpdate  (AXFX2_OVERDRIVE *overdrive);

Parameters

overdrive Pointer to an initialized AXFX2_OVERDRIVE structure.

Return Values

TRUE if successful; FALSE if unsuccessful.

Description

The AXFX2OverdriveSettingsUpdate function is used after changing parameters of the already initialized AXFX2_OVERDRIVE structure. When this function is called, the internal settings of the effect are immediately updated based on the current user parameters. The internal delay lines are cleared during this call. Memory is not freed nor reallocated during this process.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Overdrive Overview
AXFX2_OVERDRIVE
AXFX2OverdriveGetMemSize
AXFX2OverdriveInit
AXFX2OverdriveShutdown
AXFX2OverdriveCallback
AXRegisterAuxCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL