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.
Public Member Functions | Friends | List of all members
AZ::RPI::MaterialTypeSourceData::PropertyGroup Struct Reference

Public Member Functions

 AZ_CLASS_ALLOCATOR (PropertyGroup, SystemAllocator)
 
 AZ_TYPE_INFO (AZ::RPI::MaterialTypeSourceData::PropertyGroup, "{BA3AA0E4-C74D-4FD0-ADB2-00B060F06314}")
 
const AZStd::string & GetName () const
 
const AZStd::string & GetDisplayName () const
 
const AZStd::string & GetDescription () const
 
const PropertyList & GetProperties () const
 
const AZStd::string & GetShaderInputsPrefix () const
 
const AZStd::string & GetShaderOptionsPrefix () const
 
const AZStd::vector< AZStd::unique_ptr< PropertyGroup > > & GetPropertyGroups () const
 
const AZStd::vector< Ptr< MaterialFunctorSourceDataHolder > > & GetFunctors () const
 
void SetDisplayName (AZStd::string_view displayName)
 
void SetDescription (AZStd::string_view description)
 
MaterialPropertySourceData * AddProperty (AZStd::string_view name)
 
PropertyGroup * AddPropertyGroup (AZStd::string_view name)
 
void SortProperties ()
 Sort child groups and properties by name.
 

Friends

class MaterialTypeSourceData
 

Member Function Documentation

◆ AddProperty()

MaterialPropertySourceData * AZ::RPI::MaterialTypeSourceData::PropertyGroup::AddProperty ( AZStd::string_view  name)

Add a new property to this PropertyGroup.

Parameters
namea unique for the property. Must be a C-style identifier.
Returns
the new MaterialPropertySourceData, or null if the name was not valid.

◆ AddPropertyGroup()

PropertyGroup * AZ::RPI::MaterialTypeSourceData::PropertyGroup::AddPropertyGroup ( AZStd::string_view  name)

Add a new nested PropertyGroup to this PropertyGroup.

Parameters
namea unique for the property group. Must be a C-style identifier.
Returns
the new PropertyGroup, or null if the name was not valid.
The documentation for this struct was generated from the following file: