Firelight Technologies FMOD Studio API

Channel::setLowPassGain

Sets the gain of the dry signal when lowpass filtering is applied.

C++ Syntax

FMOD_RESULT Channel::setLowPassGain(
  float gain
);

C Syntax

FMOD_RESULT FMOD_Channel_SetLowPassGain(
  FMOD_CHANNEL *channel,
  float 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

• ChannelControl::getLowPassGain

Version 1.03.06 Built on Apr 17, 2014