Open 3D Engine Atom Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::RHI::ResourcePoolDescriptor Class Reference

Inherited by AZ::RHI::AliasedHeapDescriptor, AZ::RHI::BufferPoolDescriptor, AZ::RHI::ImagePoolDescriptor, AZ::RHI::QueryPoolDescriptor, AZ::RHI::ShaderResourceGroupPoolDescriptor, AZ::RHI::StreamingImagePoolDescriptor, and AZ::RHI::SwapChainDescriptor.

Public Member Functions

 AZ_RTTI (ResourcePoolDescriptor, "{C4B9BF83-B171-4DB9-93D6-0879C7CEF5C2}")
 AZ_CLASS_ALLOCATOR (ResourcePoolDescriptor, SystemAllocator)

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)

Public Attributes

AZ::u64 m_budgetInBytes = 0

Member Data Documentation

◆ m_budgetInBytes

AZ::u64 AZ::RHI::ResourcePoolDescriptor::m_budgetInBytes = 0

The budget defines the maximum amount of memory the pool is allowed to consume on its heap level. If the budget is zero, the budget is not enforced by the RHI and reservations can grow unbounded. However, the platform itself may still report out of memory errors. Therefore, it is strongly recommended to assign a budget to Device pools where virtual memory is not present on most platforms.

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