#include <ShaderCollection.h>

Public Types
enum class	DrawItemType : uint32_t { Raster = 0 , Dispatch , Deferred , RayTracing , Custom , MaxCount }

Public Member Functions
	AZ_TYPE_INFO (Item, "{64C7F381-3313-46E8-B23B-D7AA9A915F35}")

	Item ()
	Required for use in containers; not meant to be called directly.

	Item (const Data::Asset< ShaderAsset > &shaderAsset, const AZ::Name &shaderTag, DrawItemType drawItemType=DrawItemType::Raster, ShaderVariantId variantId=ShaderVariantId{})

	Item (Data::Asset< ShaderAsset > &&shaderAsset, const AZ::Name &shaderTag, DrawItemType drawItemType=DrawItemType::Raster, ShaderVariantId variantId=ShaderVariantId{})

const Data::Asset< ShaderAsset > &	GetShaderAsset () const

const ShaderVariantId &	GetShaderVariantId () const
	Return the ID of the shader variant to be used, based on the configured shader options.

const AZ::Data::AssetId &	GetShaderAssetId () const
	Returns the asset id associated to this shader item.

const AZ::RPI::ShaderOptionGroup &	GetShaderOptionGroup () const

const ShaderOptionGroup *	GetShaderOptions () const
	Return the set of shader options used to select a specific shader variant.

ShaderOptionGroup *	GetShaderOptions ()

bool	MaterialOwnsShaderOption (const AZ::Name &shaderOptionName) const

bool	MaterialOwnsShaderOption (ShaderOptionIndex shaderOptionIndex) const

const RHI::RenderStates *	GetRenderStatesOverlay () const
	Return the runtime render states overlay. Properties that are not overwritten are invalid.

RHI::RenderStates *	GetRenderStatesOverlay ()

RHI::DrawListTag	GetDrawListTagOverride () const
	Return the runtime draw list tag override.

void	SetDrawListTagOverride (RHI::DrawListTag drawList)
	Set the runtime draw list tag.

void	SetDrawListTagOverride (const AZ::Name &drawListName)

void	SetEnabled (bool enabled)
	Controls whether this shader/pass will be used for rendering a material.

bool	IsEnabled () const

const AZ::Name &	GetShaderTag () const
	Returns the shader tag used to identify this item.

void	TryReplaceShaderAsset (const Data::Asset< ShaderAsset > &newShaderAsset)

bool	InitializeShaderOptionGroup ()

DrawItemType	GetDrawItemType () const

Static Public Member Functions
static void	Reflect (AZ::ReflectContext *context)

Friends
class	MaterialTypeAssetCreator

class	ShaderVariantReferenceSerializationEvents

class	ShaderCollection

class	MaterialTypeAsset

Detailed Description

Contains shader asset and configures how that shader should be used at runtime, especially which variant of the shader to use.

Constructor & Destructor Documentation

◆ Item()

AZ::RPI::ShaderCollection::Item::Item	(	const Data::Asset< ShaderAsset > &	shaderAsset,
		const AZ::Name &	shaderTag,
		DrawItemType	drawItemType = `DrawItemType::Raster`,
		ShaderVariantId	variantId = `ShaderVariantId{}`
	)

Parameters

shaderAsset	The ShaderAsset represented by this item.
shaderTag	Unique tag to identify this item.
variantId	The the initial state of shader option values for use with this shader item.

Member Function Documentation

◆ MaterialOwnsShaderOption()

bool AZ::RPI::ShaderCollection::Item::MaterialOwnsShaderOption ( const AZ::Name & shaderOptionName ) const

Returns whether the material owns the indicate shader option in this Item. Material-owned shader options can be connected to material properties (either directly or through functors). They cannot be accessed externally (for example, through the Material::SetSystemShaderOption() function).

◆ TryReplaceShaderAsset()

void AZ::RPI::ShaderCollection::Item::TryReplaceShaderAsset ( const Data::Asset< ShaderAsset > & newShaderAsset )

If the AssetId of @newShaderAsset matches the AssetId of @m_shaderAsset, then @m_shaderAsset will be updated to @newShaderAsset, AND m_shaderOptionGroup will be updated too.

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

Gems/Atom/RPI/Code/Include/Atom/RPI.Reflect/Material/ShaderCollection.h

Public Types

Public Member Functions