Firelight Technologies FMOD Studio API

ChannelGroup::get3DOcclusion

Retrieves the occlusion factors.

C++ Syntax

FMOD_RESULT ChannelGroup::get3DOcclusion(
  float *directocclusion,
  float *reverbocclusion
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_Get3DOcclusion(
  FMOD_CHANNELGROUP *channelgroup,
  float *directocclusion,
  float *reverbocclusion
);

C# Syntax

RESULT ChannelGroup.get3DOcclusion(
  out float directocclusion,
  out float reverbocclusion
);

JavaScript Syntax

ChannelGroup.get3DOcclusion(
  directocclusion,                 // writes value to directocclusion.val
  reverbocclusion                  // writes value to reverbocclusion.val
);

Parameters

directocclusion

Address of a variable that receives the occlusion factor for the direct path.

reverbocclusion

Address of a variable that receives the occlusion factor for the reverb mix.

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

• ChannelControl::set3DOcclusion

Version 1.10.03 Built on Feb 1, 2018