Firelight Technologies FMOD Studio API
ChannelGroup::setLowPassGain
Sets the gain of the dry signal when lowpass filtering is applied.
C++ Syntax
FMOD_RESULT ChannelGroup::setLowPassGain(
float gain
);
C Syntax
FMOD_RESULT FMOD_ChannelGroup_SetLowPassGain(
FMOD_CHANNELGROUP *channelgroup,
float gain
);
C# Syntax
RESULT ChannelGroup.setLowPassGain(
float gain
);
JavaScript Syntax
ChannelGroup.setLowPassGain(
gain
);
Parameters
- gain
- Linear gain level, from 0 (silent, full filtering) to 1.0 (full volume, no filtering), default = 1.0.
Return Values
If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.
Remarks
Requires the built in lowpass to be created with FMOD_INIT_CHANNEL_LOWPASS or FMOD_INIT_CHANNEL_DISTANCEFILTER.
See Also
Version 1.10.03 Built on Feb 1, 2018