AXFX2OverdriveShutdown

Syntax

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

void AXFX2OverdriveShutdown  (AXFX2_OVERDRIVE *overdrive);

Parameters

overdrive Pointer to an initialized AXFX2_OVERDRIVE structure.

Return Values

None.

Description

The AXFX2OverdriveShutdown function frees any memory allocated internally by the AXFX2OverdriveInit functions. This function should be called after unregistered the active effect which is performed by passing NULL as the callback function parameter to AXRegisterAuxCallback.

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
AXFX2OverdriveSettingsUpdate
AXFX2OverdriveCallback
AXRegisterAuxCallback

Revision History

2013-08-26 Initial version.


CONFIDENTIAL