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.
Public Member Functions | Static Public Member Functions | List of all members
AZ::DX12::TransientAttachmentPool Class Reference

Inherits AZ::RHI::TransientAttachmentPool.

Public Member Functions

 AZ_CLASS_ALLOCATOR (TransientAttachmentPool, AZ::SystemAllocator)
 
 AZ_RTTI (TransientAttachmentPool, "{2E513E84-0161-4A0C-8148-3364BFFFC5E4}", Base)
 
- Public Member Functions inherited from AZ::RHI::TransientAttachmentPool
 AZ_RTTI (TransientAttachmentPool, "{D4A544E9-AE4A-4BD7-9E03-646DA8D86388}")
 
ResultCode Init (Device &device, const TransientAttachmentPoolDescriptor &descriptor)
 Called to initialize the pool.
 
void Shutdown ()
 Called to shutdown the pool.
 
void Begin (const TransientAttachmentPoolCompileFlags flags=TransientAttachmentPoolCompileFlags::None, const TransientAttachmentStatistics::MemoryUsage *memoryHint=nullptr)
 
void BeginScope (Scope &scopeBase)
 Called when a new scope is being allocated. Scopes are allocated in submission order.
 
virtual Image * ActivateImage (const TransientImageDescriptor &descriptor)=0
 
virtual Buffer * ActivateBuffer (const TransientBufferDescriptor &descriptor)=0
 
virtual void DeactivateBuffer (const AttachmentId &attachmentId)=0
 
virtual void DeactivateImage (const AttachmentId &attachmentId)=0
 
void EndScope ()
 Called when all allocations for the current scope have completed.
 
void End ()
 Called when the allocations / deallocations have completed for all scopes.
 
const TransientAttachmentStatistics & GetStatistics () const
 Get statistics for the pool (built during End).
 
const TransientAttachmentPoolDescriptor & GetDescriptor () const
 Get pool descriptor.
 
TransientAttachmentPoolCompileFlags GetCompileFlags () const
 Get the compile flags being used during the allocation of resources.
 
- 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< TransientAttachmentPool > Create ()
 
- Static Public Member Functions inherited from AZ::RHI::TransientAttachmentPool
static bool NeedsTransientAttachmentPool (const TransientAttachmentPoolDescriptor &descriptor)
 Returns true if a Transient Attachment Pool is needed according to the supplied descriptor.
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::TransientAttachmentPool
void CollectHeapStats (AliasedResourceTypeFlags typeMask, AZStd::span< const TransientAttachmentStatistics::Heap > heapStats)
 
- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.
 
void Shutdown () override
 Clears the current bound device to null.
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::TransientAttachmentPool
Scope * m_currentScope = nullptr
 
RHI::TransientAttachmentStatistics m_statistics
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 
The documentation for this class was generated from the following file: