Geometry::setActive

FMOD Studio API

Firelight Technologies FMOD Studio API

Geometry::setActive

Enables or disables an object from being processed in the geometry engine.

C++ Syntax

FMOD_RESULT Geometry::setActive(
  bool active
);

C Syntax

FMOD_RESULT FMOD_Geometry_SetActive(
  FMOD_GEOMETRY *geometry,
  FMOD_BOOL active
);

C# Syntax

RESULT Geometry.setActive(
  bool active
);

JavaScript Syntax

Geometry.setActive(
  active                           
);

Parameters

active
true = active, false = not active. Default = true.

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