AXFXReverbStdGetMemSize

Syntax

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

s32  AXFXReverbStdGetMemSize (AXFX_REVERBSTD *reverb);

Parameters

reverb Pointer to an AXFX_REVERBSTD structure with configured user parameters.

Return Values

Returns the size of memory required by Standard Reverb.

Description

The AXFXReverbStdGetMemSize function returns the memory size required by Standard Reverb. The required memory size varies according to AXFX_REVERBSTD structure's settings. The user must configure the AXFX_REVERBSTD structure's user parameters prior to calling this function.

The memory of the size returned by this function is allocated when Standard Reverb is initialized using the AXFXReverbStdInit and AXFXReverbStdSettings functions.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_REVERBSTD
AXFXReverbStdInit
AXFXReverbStdSettings

Revision History

2013-05-08 Automated cleanup pass.
2007-08-08 Initial version.


CONFIDENTIAL