Open 3D Engine Atom Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::RHI::ShaderInputNameIndex Struct Reference

#include <ShaderInputNameIndex.h>

Public Member Functions

 AZ_TYPE_INFO (ShaderInputNameIndex,"{1A9A92A7-9289-45E1-9EFE-D08257EF2BF1}")
 ShaderInputNameIndex (Name name)
 ShaderInputNameIndex (const char *name)
void operator= (Name name)
void operator= (const char *name)
void FindBufferIndex (const ShaderResourceGroupLayout *srgLayout)
void FindImageIndex (const ShaderResourceGroupLayout *srgLayout)
void FindSamplerIndex (const ShaderResourceGroupLayout *srgLayout)
void FindConstantIndex (const ShaderResourceGroupLayout *srgLayout)
bool ValidateOrFindBufferIndex (const ShaderResourceGroupLayout *srgLayout)
bool ValidateOrFindImageIndex (const ShaderResourceGroupLayout *srgLayout)
bool ValidateOrFindSamplerIndex (const ShaderResourceGroupLayout *srgLayout)
bool ValidateOrFindConstantIndex (const ShaderResourceGroupLayout *srgLayout)
ShaderInputBufferIndex GetBufferIndex () const
ShaderInputImageIndex GetImageIndex () const
ShaderInputConstantIndex GetConstantIndex () const
ShaderInputSamplerIndex GetSamplerIndex () const
ShaderInputStaticSamplerIndex GetStaticSamplerIndex () const
void Reset ()
bool HasName () const
void AssertHasName () const
bool IsValid () const
void AssertValid () const
bool IsInitialized () const
void AssetInialized () const
const Name & GetNameForDebug () const

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)

Detailed Description

Utility class to manage looking up indices via Names Users can initialize this class with the Name used to lookup the index and then use this class as an index. Under the hood, the code will initialize the index if it's not already initialized before using it.

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