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::Vulkan::DescriptorSetLayout Class Referencefinal

Inherits AZ::RHI::DeviceObject.

Classes

struct  Descriptor
 

Public Types

enum class  ResourceType : uint32_t {
  ConstantData , BufferView , ImageView , BufferViewUnboundedArray ,
  ImageViewUnboundedArray , Sampler , Count
}
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (DescriptorSetLayout, AZ::ThreadPoolAllocator)
 
 AZ_RTTI (DescriptorSetLayout, "25C09E30-F46B-424D-B97A-7F32592A76D7", Base)
 
RHI::ResultCode Init (const Descriptor &descriptor)
 
VkDescriptorSetLayout GetNativeDescriptorSetLayout () const
 
size_t GetDescriptorSetLayoutBindingsCount () const
 
VkDescriptorType GetDescriptorType (size_t index) const
 
uint32_t GetBindingIndex (uint32_t index) const
 
uint32_t GetLayoutIndexFromGroupIndex (uint32_t groupIndex, ResourceType type) const
 
uint32_t GetDescriptorCount (size_t descIndex) const
 
uint32_t GetConstantDataSize () const
 
const AZStd::vector< VkDescriptorSetLayoutBinding > & GetNativeLayoutBindings () const
 
const AZStd::vector< VkDescriptorBindingFlags > & GetNativeBindingFlags () const
 
const RHI::ShaderResourceGroupLayoutGetShaderResourceGroupLayout () const
 
bool GetHasUnboundedArray () 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.
 
DeviceGetDevice () 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< DescriptorSetLayoutCreate ()
 

Static Public Attributes

static const uint32_t ResourceTypeSize = static_cast<uint32_t>(ResourceType::Count)
 
static const uint32_t InvalidLayoutIndex
 
static const uint32_t MaxUnboundedArrayDescriptors = 100000
 

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
 

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