nw::snd::FxReverb::SetParam Member Function#include <nw/snd/snd_FxReverb.h>
bool SetParam(
const Param & param
);
| Name | Description | |
|---|---|---|
| in | param | Reverb parameters. |
Sets reverb parameters.
The GetRequiredMemSize function calculates the memory size required based on the reverb parameters that have been set.
The Param structure that has been set is copied internally.
Behavior changes before and after calling SoundSystem::AppendEffect and passing an instance of FxReverb.
Before calling SoundSystem::AppendEffect, a value range check is made for the m_Coloration, m_Damping, m_EarlyGain, and m_FusedGain members of the Param structure. If values are out of range, execution stops on an assert for Debug and Development versions, while false is returned for Release versions.
After SoundSystem::AppendEffect is called, in addition to the value range check performed before the call, a check is made whether the required memory size has increased. In other words, if operations such as the following:
- A value larger than when Initialize was called is set for m_EarlyReflection
- A value larger than when Initialize was called is set for m_PreDelay
- Value largers than when Initialize was called are set for each member of m_pFilterSize
- m_IsEnableSurrund is set to true even though it was set to false when Initialize was called
are performed, this function fails and returns false. If all of the conditions given above are satisfied, parameters can now be changed using SoundSystem::AppendEffect.
CONFIDENTIAL