Firelight Technologies FMOD Studio API
Studio::EventDescription::is3D
Retrieves the event's 3D status, indicating whether the event's behaviour will be affected by its 3D attributes.
C++ Syntax
FMOD_RESULT Studio::EventDescription::is3D(
bool *is3D
);
C Syntax
FMOD_RESULT FMOD_Studio_EventDescription_Is3D(
FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
FMOD_BOOL *is3D
);
C# Syntax
RESULT Studio.EventDescription.is3D(
out bool is3D
);
JavaScript Syntax
EventDescription.is3D(
is3D // writes value to is3D.val
);
Parameters
- is3D
- Address of a variable to receive the 3D status.
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
An event is considered 3D if it contains a 3D panner or an automatic parameter that depends on the event's 3D attributes:
- Distance
- Event Cone Angle
- Event Orientation
- Direction
- Elevation
An event will also return that it is 3D if it has any nested events that are 3D.
A Listener Orientation automatic parameter does not make an event 3D, as it only depends on the listener's 3D attributes.
See Also
Version 1.10.03 Built on Feb 1, 2018