nw::snd::SoundHandle::SetLpfFreq Member Function

#include <nw/snd/snd_SoundHandle.h>

void SetLpfFreq(
     f32 lpfFreq
);

	Name	Description
in	lpfFreq	This value is the relative change in the filter cutoff, with a reference point of 0.0.

None.

Changes the low pass filter cutoff value of the sound.

Changes the low pass filter cutoff value associated with the handle. If the handle is invalid, the function does nothing.

The value specified by this function operates independently of other low pass filter cutoff parameters, which are all layered.

lpfFreq specifies a value for the relative change in the cutoff frequency. When 0.0 is specified, the cutoff value is unchanged. If -1.0 is specified, the cutoff frequency changes from applying no filter to applying maximum filter (in the sense that the cutoff frequency goes down).

2010/10/18

Initial version.