Firelight Technologies FMOD Studio API
ChannelGroup::set3DDistanceFilter
Control the behaviour of a 3D distance filter, whether to enable or disable it, and frequency characteristics.
C++ Syntax
FMOD_RESULT ChannelGroup::set3DDistanceFilter(
bool custom,
float customLevel,
float centerFreq
);
C Syntax
FMOD_RESULT FMOD_ChannelGroup_Set3DDistanceFilter(
FMOD_CHANNELGROUP *channelgroup,
FMOD_BOOL custom,
float customLevel,
float centerFreq
);
C# Syntax
RESULT ChannelGroup.set3DDistanceFilter(
bool custom,
float customLevel,
float centerFreq
);
JavaScript Syntax
ChannelGroup.set3DDistanceFilter(
custom,
customLevel,
centerFreq
);
Parameters
- custom
- Specify true to disable FMOD distance rolloff calculation. Default = false.
- customLevel
- Specify a attenuation factor manually here, where 1.0 = no attenuation and 0 = complete attenuation. Default = 1.0.
- centerFreq
- Specify a center frequency in hz for the high-pass filter used to simulate distance attenuation, from 10.0 to 22050.0. Default = 1500.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.
See Also
Version 1.10.03 Built on Feb 1, 2018