AZ::DX12::BufferPool Class Reference

Inherits AZ::RHI::DeviceBufferPool.

Public Member Functions
	AZ_RTTI (BufferPool, "{BC251841-AADD-4A4A-A4FF-4F94897541D5}", Base)
	AZ_CLASS_ALLOCATOR (BufferPool, AZ::SystemAllocator)
Public Member Functions inherited from AZ::RHI::DeviceBufferPool
ResultCode	Init (Device &device, const BufferPoolDescriptor &descriptor)
ResultCode	InitBuffer (const DeviceBufferInitRequest &request)
ResultCode	OrphanBuffer (DeviceBuffer &buffer)
ResultCode	MapBuffer (const DeviceBufferMapRequest &request, DeviceBufferMapResponse &response)
void	UnmapBuffer (DeviceBuffer &buffer)
ResultCode	StreamBuffer (const DeviceBufferStreamRequest &request)
const BufferPoolDescriptor &	GetDescriptor () const override final
Public Member Functions inherited from AZ::RHI::DeviceBufferPoolBase
	AZ_RTTI (DeviceBufferPoolBase, "{28D265BB-3B90-4676-BBA9-3F933F14CB01}", DeviceResourcePool)
Public Member Functions inherited from AZ::RHI::DeviceResourcePool
	AZ_RTTI (DeviceResourcePool, "{757EB674-25DC-4D00-9808-D3DAF33A4EFE}", DeviceObject)
void	Shutdown () override final
	Shuts down the pool. This method will shutdown all resources associated with the pool.
template<typename ResourceType >
void	ForEach (AZStd::function< void(ResourceType &)> callback)
template<typename ResourceType >
void	ForEach (AZStd::function< void(const ResourceType &)> callback) const
uint32_t	GetResourceCount () const
	Returns the number of resources in the pool.
ResourcePoolResolver *	GetResolver ()
	Returns the resolver for this pool.
const ResourcePoolResolver *	GetResolver () const
const HeapMemoryUsage &	GetHeapMemoryUsage (HeapMemoryLevel heapMemoryLevel) const
	Returns the memory used by this pool for a specific heap type.
const PoolMemoryUsage &	GetMemoryUsage () const
	Returns the memory used by this pool.
Public Member Functions inherited from AZ::RHI::DeviceObject
	AZ_RTTI (DeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)
bool	IsInitialized () const
	Returns whether the device object is initialized.
Device &	GetDevice () const
Public Member Functions inherited from AZ::RHI::Object
	AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}")
void	SetName (const Name &name)
	Sets the name of the object.
const Name &	GetName () const
	Returns the name set on the object by SetName.
uint32_t	use_count ()
	Returns the current use count of the object.

Static Public Member Functions
static RHI::Ptr< BufferPool >	Create ()

Additional Inherited Members
Protected Types inherited from AZ::RHI::DeviceResourcePool
using	PlatformMethod = AZStd::function< RHI::ResultCode()>
	A simple functor that returns a result code.
Protected Member Functions inherited from AZ::RHI::DeviceBufferPool
void	OnFrameBegin () override
bool	ValidateNotProcessingFrame () const
Protected Member Functions inherited from AZ::RHI::DeviceBufferPoolBase
ResultCode	InitBuffer (DeviceBuffer *buffer, const BufferDescriptor &descriptor, PlatformMethod platformInitResourceMethod)
void	ValidateBufferMap (DeviceBuffer &buffer, bool isDataValid)
bool	ValidateBufferUnmap (DeviceBuffer &buffer)
uint32_t	GetMapRefCount () const
Protected Member Functions inherited from AZ::RHI::DeviceResourcePool
void	OnFrameBegin () override
void	OnFrameCompile () override
void	OnFrameEnd () override
void	SetResolver (AZStd::unique_ptr< ResourcePoolResolver > &&resolvePolicy)
ResultCode	Init (Device &device, const ResourcePoolDescriptor &descriptor, const PlatformMethod &initMethod)
ResultCode	InitResource (DeviceResource *resource, const PlatformMethod &initResourceMethod)
bool	ValidateIsRegistered (const DeviceResource *resource) const
bool	ValidateIsUnregistered (const DeviceResource *resource) const
bool	ValidateIsInitialized () const
	Validates that the resource pool is initialized and ready to service requests.
bool	ValidateNotProcessingFrame () const
	Validates that we are not in the frame processing phase.
Protected Member Functions inherited from AZ::RHI::DeviceObject
void	Init (Device &device)
	The derived class should call this method to assign the device.
Protected Member Functions inherited from AZ::RHI::Object
void	add_ref () const
void	release () const
Protected Attributes inherited from AZ::RHI::DeviceResourcePool
PoolMemoryUsage	m_memoryUsage
Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int	m_useCount = 0

---

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

• Gems/Atom/RHI/DX12/Code/Source/RHI/BufferPool.h