Firelight Technologies FMOD Studio API
FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI
Structure for data parameters of type FMOD_DSP_PARAMETER_DATA_TYPE_3DATTRIBUTES_MULTI.
A parameter of this type is used in effects that respond to a 3D position and support multiple listeners.
C/C++ Syntax
typedef struct {
int numlisteners;
FMOD_3D_ATTRIBUTES relative[FMOD_MAX_LISTENERS];
float weight[FMOD_MAX_LISTENERS];
FMOD_3D_ATTRIBUTES absolute;
} FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI;
JavaScript Syntax
struct FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI
{
numlisteners,
};
Members
numlisteners
[w] The number of listeners.
relative
[w] The position of the sound relative to the listeners.
weight
[w] The weighting of the listeners where 0 means listener has no contribution and 1 means full contribution.
absolute
[w] The position of the sound in world coordinates.
Remarks
The FMOD::Studio::System will set this parameter automatically if an FMOD::Studio::EventInstance position changes, however if using the low level FMOD::System you must set this DSP parameter explicitly.
Attributes must use a coordinate system with the positive Y axis being up and the positive X axis being right. FMOD will convert passed in coordinates to left-handed for the plugin if the System was initialized with the FMOD_INIT_3D_RIGHTHANDED flag.
Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.
Members marked with [w] mean the variable can be written to. The user can set the value.
JavaScript only :
Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.DSP_PARAMETER_3DATTRIBUTES_MULTI()", no 'new' keyword is required.
See Also
Version 1.10.03 Built on Feb 1, 2018