Firelight Technologies FMOD Studio API
ChannelGroup::set3DOcclusion
Sets the occlusion factors manually for when the FMOD geometry engine is not being used.
C++ Syntax
FMOD_RESULT ChannelGroup::set3DOcclusion(
float directocclusion,
float reverbocclusion
);
C Syntax
FMOD_RESULT FMOD_ChannelGroup_Set3DOcclusion(
FMOD_CHANNELGROUP *channelgroup,
float directocclusion,
float reverbocclusion
);
C# Syntax
RESULT ChannelGroup.set3DOcclusion(
float directocclusion,
float reverbocclusion
);
JavaScript Syntax
ChannelGroup.set3DOcclusion(
directocclusion,
reverbocclusion
);
Parameters
- directocclusion
- Occlusion factor for the direct path, from 0.0 (not occluded) to 1.0 (fully occluded), default = 0.0.
- reverbocclusion
- Occlusion factor for the reverb mix, from 0.0 (not occluded) to 1.0 (fully occluded), default = 0.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
Normally the volume is simply attenuated by the 'directocclusion' factor however if FMOD_INIT_CHANNEL_LOWPASS is specified frequency filtering will be used with a very small CPU hit.
See Also
Version 1.10.03 Built on Feb 1, 2018