AXFXChorusInit

C Specification

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

BOOL AXFXChorusInit(AXFX_CHORUS *chorus);

Arguments

chorus   Pointer to initialized instance of AXFX_CHORUS.

Return Values

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

Description

AXFXChorusInit() initializes the chorus effect using the specified AXFX_CHORUS effects data structure. The user must initialize the AXFX_CHORUS chorus settings prior to calling AXFXChorusInit(). This function will allocate memory for the reverb, and start the effect quietly.

See Also

AXFXChorusShutdown
AXFXChorusSettings
AXFXChorusCallback

Revision History

03/01/2006 Initial version.