Firelight Technologies FMOD Studio API

Channel::get3DMinMaxDistance

Retrieves the minimum and maximum audible distance.

C++ Syntax

FMOD_RESULT Channel::get3DMinMaxDistance(
  float *mindistance,
  float *maxdistance
);

C Syntax

FMOD_RESULT FMOD_Channel_Get3DMinMaxDistance(
  FMOD_CHANNEL *channel,
  float *mindistance,
  float *maxdistance
);

Parameters

mindistance
Address of a variable that receives the minimum volume distance in 'units' (see remarks). Optional, specify 0 or NULL to ignore.
maxdistance
Address of a variable that receives the maximum volume distance in 'units' (see remarks). Optional, specify 0 or NULL to ignore.

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

A 'distance unit' is specified by System::set3DSettings. By default this is set to meters which is a distance scale of 1.0.

See Also




Version 1.03.06 Built on Apr 17, 2014