AXFXChorusGetMemSize

Syntax

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

s32  AXFXChorusGetMemSize (AXFX_CHORUS *chorus);

Parameters

chorus Pointer to AXFX_CHORUS structure with configured user parameters.

Return Values

Returns the size of memory required by Chorus.

Description

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

The memory size returned by this function is allocated when the Chorus Expansion is initialized using the AXFXChorusInit and AXFXChorusSettingsfunctions.

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
AXFXChorusInit
AXFXChorusSettings

Revision History

2013-05-08 Automated cleanup pass.
2008-06-05 Added notes.
2007-08-09 Initial version.


CONFIDENTIAL