AXFXReverbHiGetMemSize

Syntax

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

s32  AXFXReverbHiGetMemSize (AXFX_REVERBHI *reverb);

Parameters

reverb Pointer to an AXFX_REVERBHI structure with configured user parameters.

Return Values

Returns the size of memory required by High-Quality Reverb.

Description

The AXFXReverbHiGetMemSize function returns the size of memory required by High-Quality Reverb. The required memory size varies according to settings in the AXFX_REVERBHI structure. The user must configure the AXFX_REVERBHI structure's user parameters prior to calling this function.

The memory of the size returned by this function is allocated when High-Quality Reverb is initialized using the AXFXReverbHiInit and AXFXReverbHiSettings functions.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_REVERBHI
AXFXReverbHiInit
AXFXReverbHiSettings

Revision History

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


CONFIDENTIAL