bool SetParam(
const Param & param
);
| Name | Description | |
|---|---|---|
| in | param | The reverb parameter. |
true when configuration succeeded and false when it failed (when an out-of-range value was configured, etc.). Configures the reverb parameters.
The GetRequiredMemSize function calculates the required memory sized based on the reverb parameters configured here.
The configured Param structure, is copied internally.
The behavior differs when calling SetEffect before and after passing the FxReverb instance.
Before calling the SetEffect function, range checks are performed on m_Coloration, m_Damping, m_EarlyGain, and m_FusedGain within the Param structure. When out of range, you halt on an assert in the debug/development versions, and false is returned in the release version.
After calling the SetEffect function, a check is performed for whether additional memory is needed, in addition to the range check performed before calling. In other words, if a larger value is configured for m_EarlyReflection then was configured when the SetEffect function was called, or if a larger value is configured for m_PreDelay than was configured when the SetEffect function was called, or if larger values are configured for the members of m_pFilterSize than were configured when the SetEffect function was called, then this function fails and returns false. If the above conditions are not met, subsequent parameter changes can be made with the SetEffect function.
CONFIDENTIAL