Firelight Technologies FMOD Studio API
Memory_GetStats
Returns information on the memory usage of FMOD. This information is byte accurate and counts all allocs and frees internally.
C++ Syntax
FMOD_RESULT Memory_GetStats(
int *currentalloced,
int *maxalloced,
bool blocking
);
C Syntax
FMOD_RESULT FMOD_Memory_GetStats(
int *currentalloced,
int *maxalloced,
FMOD_BOOL blocking
);
C# Syntax
static RESULT Memory.GetStats(
out int currentalloced,
out int maxalloced,
bool blocking
);
JavaScript Syntax
FMOD.Memory_GetStats(
currentalloced,,
maxalloced,,
blocking,
);
Parameters
currentalloced
Address of a variable that receives the currently allocated memory at time of call. Optional. Specify 0 or NULL to ignore.
maxalloced
Address of a variable that receives the maximum allocated memory since System::init or Memory_Initialize. Optional. Specify 0 or NULL to ignore.
blocking
Boolean indicating whether to favour speed or accuracy. Specifying true for this parameter will flush the DSP network to make sure all queued allocations happen immediately, which can be costly.
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
This is useful for determining a fixed memory size to make FMOD work within for fixed memory machines such as consoles.
Note that if using FMOD::Memory_Initialize, the memory usage will be slightly higher than without it, as FMOD has to have a small amount of memory overhead to manage the available memory.
See Also
Version 1.10.03 Built on Feb 1, 2018