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::RPI::MaterialFunctorSourceData::EditorContext Struct Reference

Public Member Functions

 EditorContext (const AZStd::string &materialTypeFilePath, const MaterialPropertiesLayout *materialPropertiesLayout, const MaterialNameContext *materialNameContext)
 
const AZStd::string & GetMaterialTypeSourceFilePath () const
 
const MaterialPropertiesLayoutGetMaterialPropertiesLayout () const
 
MaterialPropertyIndex FindMaterialPropertyIndex (Name propertyId) const
 
const MaterialNameContextGetNameContext () const
 

Member Function Documentation

◆ FindMaterialPropertyIndex()

MaterialPropertyIndex AZ::RPI::MaterialFunctorSourceData::EditorContext::FindMaterialPropertyIndex ( Name  propertyId) const

Find a property's index by its name. It will report error and return a Null index if it fails. This will also automatically apply the MaterialNameContext.

◆ GetNameContext()

const MaterialNameContext * AZ::RPI::MaterialFunctorSourceData::EditorContext::GetNameContext ( ) const
inline

Returns the name context for the functor. It acts like a namespace for any names that the MaterialFunctorSourceData might reference. The namespace is automatically applied by the other relevant functions of this RuntimeContext class. Note that by default the MaterialNameContext is not saved as part of the final MaterialFunctor class (most CreateFunctor() implementations should convert names to indexes anyway) but CreateFunctor() can copy it to the created MaterialFunctor for use at runtime if needed.


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