Open 3D Engine Atom Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
D3D12MA::Budget Struct Reference

Statistics of current memory usage and available budget for a specific memory segment group. More...

#include <D3D12MemAlloc.h>

Public Attributes

Statistics Stats
 Statistics fetched from the library.
 
UINT64 UsageBytes
 Estimated current memory usage of the program. More...
 
UINT64 BudgetBytes
 Estimated amount of memory available to the program. More...
 

Detailed Description

Statistics of current memory usage and available budget for a specific memory segment group.

These are fast to calculate. See function D3D12MA::Allocator::GetBudget().

Member Data Documentation

◆ BudgetBytes

UINT64 D3D12MA::Budget::BudgetBytes

Estimated amount of memory available to the program.

Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.

It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.

◆ UsageBytes

UINT64 D3D12MA::Budget::UsageBytes

Estimated current memory usage of the program.

Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.

It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.


The documentation for this struct was generated from the following file: