AXFXChorusExpGetMemSize

Syntax

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

s32  AXFXChorusExpGetMemSize (AXFX_CHORUS_EXP *chorus);

Parameters

chorus Pointer to an AXFX_CHORUS_EXP structure with configured user parameters.

Return Values

Returns the size of memory required by the Chorus Expansion.

Description

The AXFXChorusExpGetMemSize function returns the size of memory required by the Chorus Expansion. The required memory size varies according to settings in the AXFX_CHORUS_EXP structure. The user must configure the AXFX_CHORUS_EXP structure's user parameters prior to calling this function.

The memory of the size returned by this function is allocated when Chorus Expansion is initialized using the AXFXChorusExpInit or AXFXChorusExpSettings functions.

NOTE:
Current specifications have fixed the memory size. It is unaffected by parameter values.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_CHORUS_EXP
AXFXChorusExpInit
AXFXChorusExpSettings

Revision History

2013/05/08 Automated cleanup pass.
2008/06/05 Added notes.
2007/08/10 Initial version.


CONFIDENTIAL