Studio::System::getBufferUsage

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::System::getBufferUsage

Retrieves information about various memory buffers used by FMOD Studio.

C++ Syntax

FMOD_RESULT Studio::System::getBufferUsage(
  FMOD_STUDIO_BUFFER_USAGE *usage
);

C Syntax

FMOD_RESULT FMOD_Studio_System_GetBufferUsage(
  FMOD_STUDIO_SYSTEM *system,
  FMOD_STUDIO_BUFFER_USAGE *usage
);

C# Syntax

RESULT Studio.System.getBufferUsage(
  out BUFFER_USAGE usage
);

JavaScript Syntax

System.getBufferUsage(
  usage                            // writes value to usage.val
);

Parameters

usage
Address of a variable to receive the performance information.

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

Stall count and time values are cumulative. They can be reset by calling Studio::System::resetBufferUsage.

Stalls due to the studio command queue can be avoided by calling Studio::System::setAdvancedSettings to set a larger queue size.

See Also




Version 1.10.03 Built on Feb 1, 2018