Firelight Technologies FMOD Studio API
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
);
C# Syntax
RESULT Reverb3D.get3DAttributes(
ref VECTOR position,
ref float mindistance,
ref float maxdistance
);
JavaScript Syntax
Reverb3D.get3DAttributes(
position, // writes value to position.val
mindistance, // writes value to mindistance.val
maxdistance // writes value to maxdistance.val
);
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.
Please note that this only applies to software channels. When the listener is within the sphere of effect of one or more 3D reverbs, the listener's 3D reverb properties are a weighted combination of such 3D reverbs. When the listener is outside all of the reverbs, the 3D reverb setting is set to the default ambient reverb setting.
See Also
Version 1.10.03 Built on Feb 1, 2018