Reverb3D::get3DAttributes

Retrieves the 3d attributes of a Reverb object.

C++ Syntax

FMOD_RESULT Reverb3D::get3DAttributes(
  FMOD_VECTOR *position,
  float *mindistance,
  float *maxdistance
);

C Syntax

FMOD_RESULT FMOD_Reverb3D_Get3DAttributes(
  FMOD_REVERB3D *reverb3d,
  FMOD_VECTOR *position,
  float *mindistance,
  float *maxdistance
);

Parameters

position: Address of a variable that will receive the 3d position of the center of the reverb in 3d space. Default = { 0,0,0 }.
mindistance: Address of a variable that will receive the distance from the centerpoint that the reverb will have full effect at. Default = 0.0.
maxdistance: Address of a variable that will receive the distance from the centerpoint that the reverb will not have any effect. 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

The 3D reverb object is a sphere having 3D attributes (position, minimum distance, maximum distance) and reverb properties.

The properties and 3D attributes of all reverb objects collectively determine, along with the listener's position, the settings of and input gains into a single 3D reverb DSP.