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::RHI::ShaderInputImageDescriptor Class Referencefinal

Public Member Functions

 AZ_TYPE_INFO (ShaderInputImageDescriptor, "{913DBF3C-5556-4524-B928-174A42516D31}")
 
 ShaderInputImageDescriptor (const Name &name, ShaderInputImageAccess access, ShaderInputImageType type, uint32_t imageCount, uint32_t registerId, uint32_t spaceId)
 
HashValue64 GetHash (HashValue64 seed=HashValue64{ 0 }) const
 

Static Public Member Functions

static void Reflect (ReflectContext *context)
 

Public Attributes

Name m_name
 The name id used to reflect the image input.
 
ShaderInputImageType m_type = ShaderInputImageType::Unknown
 The type of image required for this shader input.
 
ShaderInputImageAccess m_access = ShaderInputImageAccess::Read
 How the array elements in the image input are accessed.
 
uint32_t m_count = 0
 Number of images array elements.
 
uint32_t m_registerId = UndefinedRegisterSlot
 
uint32_t m_spaceId = UndefinedRegisterSlot
 

Member Data Documentation

◆ m_registerId

uint32_t AZ::RHI::ShaderInputImageDescriptor::m_registerId = UndefinedRegisterSlot

Register id of the resource in the SRG. This is only valid if the platform compiles the SRGs using "spaces". If not, this same information will be in the PipelineLayoutDescriptor. Some platforms (like Vulkan) need the register number when creating the SRG, others need it when creating the PipelineLayout.

◆ m_spaceId

uint32_t AZ::RHI::ShaderInputImageDescriptor::m_spaceId = UndefinedRegisterSlot

Logical Register Space that the register id is within. This is primarily used when an SRG contains one or more unbounded arrays, as an unbounded array contains all register ids in a register space. If an SRG doesn't contain any unbounded arrays all resources in it will use the same space id.


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