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.
Classes | Public Member Functions | List of all members
AZ::Vulkan::DescriptorSetAllocator Class Referencefinal

#include <DescriptorSetAllocator.h>

Inherits AZ::RHI::DeviceObject.

Classes

struct  Descriptor
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (DescriptorSetAllocator, AZ::SystemAllocator)
 
RHI::ResultCode Init (const Descriptor &descriptor)
 
RHI::Ptr< ObjectType > Allocate (DescriptorSetLayout &layout)
 
void DeAllocate (RHI::Ptr< ObjectType > descriptor)
 
void Collect ()
 
void Shutdown () override
 Clears the current bound device to null.
 
- 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.
 

Additional Inherited Members

- 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::Object
AZStd::atomic_int m_useCount = 0
 

Detailed Description

Allocator for creating descriptor sets. Each descriptor set is allocated from a descriptor set pool. When the pool can't allocate more descriptor sets we create a new pool. We use the return value from Vulkan to check if the pool ran out of memory and we need to create a new one. A DescriptorSetAllocator is used to generate new descriptor set pools when needed.

Member Function Documentation

◆ Shutdown()

void AZ::Vulkan::DescriptorSetAllocator::Shutdown ( )
overridevirtual

Clears the current bound device to null.

Reimplemented from AZ::RHI::DeviceObject.

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