Firelight Technologies FMOD Studio API
Geometry::getPolygonAttributes
Retrieves the attributes for a particular polygon inside a geometry object.
C++ Syntax
FMOD_RESULT Geometry::getPolygonAttributes(
int index,
float *directocclusion,
float *reverbocclusion,
bool *doublesided
);
C Syntax
FMOD_RESULT FMOD_Geometry_GetPolygonAttributes(
FMOD_GEOMETRY *geometry,
int index,
float *directocclusion,
float *reverbocclusion,
FMOD_BOOL *doublesided
);
C# Syntax
RESULT Geometry.getPolygonAttributes(
int index,
out float directocclusion,
out float reverbocclusion,
out bool doublesided
);
JavaScript Syntax
Geometry.getPolygonAttributes(
index,
directocclusion, // writes value to directocclusion.val
reverbocclusion, // writes value to reverbocclusion.val
doublesided // writes value to doublesided.val
);
Parameters
- index
- Polygon index inside the object.
- directocclusion
- Address of a variable to receieve the occlusion value from 0.0 to 1.0 which affects volume or audible frequencies. 0.0 = The polygon does not occlude volume or audible frequencies (sound will be fully audible), 1.0 = The polygon fully occludes (sound will be silent).
- reverbocclusion
- Address of a variable to receieve the occlusion value from 0.0 to 1.0 which affects the reverb mix. 0.0 = The polygon does not occlude reverb (reverb reflections still travel through this polygon), 1.0 = The polyfully fully occludes reverb (reverb reflections will be silent through this polygon).
- doublesided
- Address of a variable to receieve the description of polygon if it is double sided or single sided. true = polygon is double sided, false = polygon is single sided, and the winding of the polygon (which determines the polygon's normal) determines which side of the polygon will cause occlusion.
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.
See Also
Version 1.10.03 Built on Feb 1, 2018