AXFXReverbHiSettings

Syntax

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

BOOL AXFXReverbHiSettings(AXFX_REVERBHI *reverb);

Parameters

reverb Pointer to an initialized AXFX_REVERBHI structure.

Return Values

TRUE if successful; FALSE if a parameter is out of range or memory allocation fails.

Description

The AXFXReverbHiSettings function is used when changing parameters of the initialized High-Quality Reverb (= AXFX_REVERBHI structure). When this function is called, the current High-Quality Reverb is shut down and the memory allocated to it at initialization is freed. This function then reinitializes High-Quality Reverb based on new user parameters.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_REVERBHI

Revision History

2013/05/08 Automated cleanup pass.
2007/08/08 Standardized notation.
2006/03/01 Initial version.


CONFIDENTIAL