MemoryStat

Scaleform::Stat
    Scaleform::MemoryStat

Declaration

class MemoryStat : public Stat;

Description

MemoryStats records memory allocation statistics for a particular allocation Id type. MemoryStat keeps track of the number of bytes allocated and used, including peak memory usage. Unlike allocation size, parameter "used" includes the number of bytes occupied in the allocator for maintaining the block, including the different header and alignment space.

Data Members

Data Member	Description
Allocated	Number of bytes allocated for the memory blocks.
AllocCount	Number of allocated memory blocks.
Used	Number of bytes occupied in the allocator for maintaining the block, including the different header and alignment space.

Methods

Method	Description
Add	Adds the allocation statistics of another MemoryStat object to the current object.
GetAllocated	Returns the number of bytes allocated for the memory blocks.
GetAllocCount	Returns the number of blocks allocated.
GetStatType	Returns the type of the statistics generated.
GetStat	Obtains the statistics value of the memory allocation counter.
GetStatCount	Obtains the maximum number of statistics in the memory statistics counter.
GetUsed	Returns the number of bytes allocated for maintaining the memory block.
Increment	Increments the bytes allocated for the memory block.
Init	Initializes the memory allocation statistics counter.
MemoryStat	Initializes MemoryStat object.
Reset	Resets the memory allocation statistics.
SetMax	Compares with another MemoryStat object and sets the maximum of the allocation statistics to the current MemoryStat object.
SetMin	Compares with another MemoryStat object and sets the minimum of the allocation statistics to the current MemoryStat object.

Operators

Operator	Description
+=	Increments the allocation size of the current MemoryStat object by adding the allocation statistics of another MemoryStat object to the current one.
-=	Decrements the allocation statistics of the current MemoryStat object by subtracting the allocation statistics of another MemoryStat object from the current one.

File

SF_Stats.h