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::DX12::MemoryPageAllocator Class Reference

Inherits AZ::RHI::ObjectPool< MemoryPageAllocatorTraits >.

Public Member Functions

size_t GetPageCount () const
 
size_t GetPageSize () const
 
- Public Member Functions inherited from AZ::RHI::ObjectPool< MemoryPageAllocatorTraits >
 ObjectPool (ObjectPool &rhs)=delete
 
void Init (const Descriptor &descriptor)
 Initializes the pool to an empty state.
 
void Shutdown ()
 Shutdown the pool. The user must re-initialize to use it again.
 
ObjectTypeAllocate (Args &&... args)
 
void DeAllocate (ObjectType *object)
 
void DeAllocate (ObjectType *objects, size_t objectCount)
 
void DeAllocate (ObjectType **objects, size_t objectCount)
 
void Collect ()
 Performs an object collection cycle. Objects which are collected can be reused by Allocate.
 
void CollectForce ()
 Performs an object collection cycle that ignores the collect latency, processing all objects.
 
size_t GetObjectCount () const
 Returns the total number of objects in the pool.
 
const ObjectFactoryTypeGetFactory () const
 

Additional Inherited Members

- Public Types inherited from AZ::RHI::ObjectPool< MemoryPageAllocatorTraits >
using ObjectType = typename Traits::ObjectType
 The type of object created and managed by this pool. Must inherit from Object.
 
using ObjectFactoryType = typename Traits::ObjectFactoryType
 The type of the object factory. An instance of this object.
 
using ObjectFactoryDescriptor = typename ObjectFactoryType::Descriptor
 The type of the descriptor used to initialize the object factory.
 
using ObjectCollectorType = ObjectCollector< MemoryPageAllocatorTraits >
 The type of object collector used by the object pool.
 
using MutexType = typename Traits::MutexType
 

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