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 Types | Public Member Functions | Static Public Member Functions | List of all members
AZ::Vulkan::NullDescriptorManager Class Reference

#include <NullDescriptorManager.h>

Inherits AZ::RHI::DeviceObject.

Public Types

enum class  ImageTypes : uint32_t {
  General2D = 0 , ReadOnly2D , Storage2D , MultiSampleGeneral2D ,
  MultiSampleReadOnly2D , GeneralArray2D , ReadOnlyArray2D , StorageArray2D ,
  GeneralCube , ReadOnlyCube , General3D , ReadOnly3D ,
  Count
}
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (NullDescriptorManager, SystemAllocator)
 
RHI::ResultCode Init (Device &device)
 Initialize the different image and buffer null descriptors.
 
void Shutdown () override
 Release all the image, buffer, and texel view null descriptors.
 
const BufferView & GetTexelBufferView () const
 Returns the texel buffer view null descriptor.
 
const Buffer & GetBuffer () const
 Returns the buffer null descriptor.
 
VkDescriptorImageInfo GetDescriptorImageInfo (RHI::ShaderInputImageType imageType, bool storageImage) const
 
- 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< NullDescriptorManager > Create ()
 

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

The NullDescriptorManager creates filler descriptor for unbounded, un-initialized resources referenced in the shader. These include images, buffers, and texel buffer.

Member Function Documentation

◆ GetDescriptorImageInfo()

VkDescriptorImageInfo AZ::Vulkan::NullDescriptorManager::GetDescriptorImageInfo ( RHI::ShaderInputImageType  imageType,
bool  storageImage 
) const

Returns the null descriptor for image info based on the image type, access, and if the image is used as storage

◆ Shutdown()

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

Release all the image, buffer, and texel view null descriptors.

Reimplemented from AZ::RHI::DeviceObject.

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