LiteFX::Rendering::MemoryHeapStatistics Struct Reference

Stores simple memory heap statistics, that can be quickly queried by calling IGraphicsFactory::memoryStatistics More...

#include <rendering_api.hpp>

Public Attributes
bool	onGpu { false }
	true, if the heap is located in video memory and false otherwise.
bool	cpuVisible { false }
	true, of the heap is accessible for the CPU and false otherwise.
UInt32	blocks {}
	Returns the number of memory blocks in the heap.
UInt32	allocations {}
	Returns the total number of allocations in the heap.
UInt64	blockSize {}
	Returns the total size of allocated memory across all blocks in the heap.
UInt64	allocationSize {}
	Returns the total size of memory for all allocations in the heap. Always less or equal to totalBlockSize.
UInt64	usedMemory {}
	Estimated memory used by the program in the heap.
UInt64	availableMemory {}
	Estimated memory available to the program in the heap.

Detailed Description

Stores simple memory heap statistics, that can be quickly queried by calling IGraphicsFactory::memoryStatistics

Member Data Documentation

allocations

UInt32 LiteFX::Rendering::MemoryHeapStatistics::allocations {}

Returns the total number of allocations in the heap.

allocationSize

UInt64 LiteFX::Rendering::MemoryHeapStatistics::allocationSize {}

Returns the total size of memory for all allocations in the heap. Always less or equal to totalBlockSize.

availableMemory

UInt64 LiteFX::Rendering::MemoryHeapStatistics::availableMemory {}

Estimated memory available to the program in the heap.

This value best represents the actual memory available to the program in the heap

See also

usedMemory

blocks

UInt32 LiteFX::Rendering::MemoryHeapStatistics::blocks {}

Returns the number of memory blocks in the heap.

blockSize

UInt64 LiteFX::Rendering::MemoryHeapStatistics::blockSize {}

Returns the total size of allocated memory across all blocks in the heap.

cpuVisible

bool LiteFX::Rendering::MemoryHeapStatistics::cpuVisible { false }

true, of the heap is accessible for the CPU and false otherwise.

onGpu

bool LiteFX::Rendering::MemoryHeapStatistics::onGpu { false }

true, if the heap is located in video memory and false otherwise.

usedMemory

UInt64 LiteFX::Rendering::MemoryHeapStatistics::usedMemory {}

Estimated memory used by the program in the heap.

This value best represents the actual memory pressure of the program in the heap, as it not only factors in allocations, but also other resources.