1. Epic GamesDeveloper
  3. FMaterialAttributeDefinitionMap

FMaterialAttributeDefinitionMap

Material property to attribute data mappings

API > API/Runtime > API/Runtime/Engine

Material property to attribute data mappings

   
Name FMaterialAttributeDefinitionMap
Type class
Header File /Engine/Source/Runtime/Engine/Public/Materials/MaterialAttributeDefinitionMap.h
Include Path #include "Materials/MaterialAttributeDefinitionMap.h"

Syntax

class FMaterialAttributeDefinitionMap

Constructors

Name Remarks Include Path Unreal Specifiers

FMaterialAttributeDefinitionMap()

   Materials/MaterialAttributeDefinitionMap.h  

Constants

Name Type Remarks Include Path
GMaterialPropertyAttributesMap FMaterialAttributeDefinitionMap   Materials/MaterialAttributeDefinitionMap.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AttributeDDCString FString   Materials/MaterialAttributeDefinitionMap.h  
AttributeMap TMap< EMaterialProperty, FMaterialAttributeDefintion >   Materials/MaterialAttributeDefinitionMap.h  
bIsInitialized bool   Materials/MaterialAttributeDefinitionMap.h  
CustomAttributes TArray< FMaterialCustomOutputAttributeDefintion >   Materials/MaterialAttributeDefinitionMap.h  
OrderedVisibleAttributeList TArray< FGuid >   Materials/MaterialAttributeDefinitionMap.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void AddCustomAttribute ( const FGuid& AttributeID,
UClass* ExpressionClass,
const FString& AttributeName,
const FString& FunctionName,
int32 OutputIndex,
EMaterialValueType ValueType,
const FVector4& DefaultValue,
EShaderFrequency ShaderFrequency,
bool bNeedsPreviousFrameEvaluation,
MaterialAttributeBlendFunction BlendFunction
)

 Appends a new attribute definition to the custom output list Materials/MaterialAttributeDefinitionMap.h  

static void AppendDDCKey ( FShaderKeyGenerator& KeyGen
)

   Materials/MaterialAttributeDefinitionMap.h  

static void AppendDDCKeyString ( FString& String
)

 Appends a hash of the property map intended for use with the DDC key Materials/MaterialAttributeDefinitionMap.h  

static int32 CompileDefaultExpression ( FMaterialCompiler* Compiler,
const FGuid& AttributeID
)

 Compiles the default expression for a material attribute Materials/MaterialAttributeDefinitionMap.h  

static int32 CompileDefaultExpression ( FMaterialCompiler* Compiler,
EMaterialProperty Property
)

 Compiles the default expression for a material attribute Materials/MaterialAttributeDefinitionMap.h  

static const FString & GetAttributeName ( const FGuid& AttributeID
)

 Returns the display name of a material attribute Materials/MaterialAttributeDefinitionMap.h  

static const FString & GetAttributeName ( EMaterialProperty Property
)

 Returns the display name of a material attribute Materials/MaterialAttributeDefinitionMap.h  

static void GetAttributeNameToIDList ( TArray< TPair< FString, FGuid > >& NameToIDList
)

 Returns a list of display names and their associated GUIDs for material properties Materials/MaterialAttributeDefinitionMap.h  

static FText GetAttributeOverrideForMaterial ( const FGuid& AttributeID,
UMaterial* Material
)

 Helper functions to determine display name based on shader model, material domain, etc. Materials/MaterialAttributeDefinitionMap.h  

static uint64 GetBitmask ( EMaterialProperty Property
)

 Returns a bitmask with just the bit corresponding to this property set Materials/MaterialAttributeDefinitionMap.h  

static uint64 GetBitmask ( const FGuid& AttributeID
)

 Returns a bitmask with just the bit corresponding to this attribute set Materials/MaterialAttributeDefinitionMap.h  

static MaterialAttributeBlendFunction GetBlendFunction ( const FGuid& AttributeID
)

 Returns the custom blend function of a material attribute Materials/MaterialAttributeDefinitionMap.h  

static uint64 GetConnectedMaterialAttributesBitmask ( TConstArrayView< class UMaterialExpression* > Expressions
)

 Returns a bitmask of all attributes/properties that are set via Set/MakeMaterialAttribute expressions, taking material function calls into account Materials/MaterialAttributeDefinitionMap.h  

static uint64 GetConnectedMaterialAttributesBitmask ( TConstArrayView< TObjectPtr< class UMaterialExpression > > Expressions
)

 Returns a bitmask of all attributes/properties that are set via Set/MakeMaterialAttribute expressions, taking material function calls into account Materials/MaterialAttributeDefinitionMap.h  

static uint64 GetConnectedMaterialAttributesBitmask_Internal ( const ExpressionsArrayType& Expressions
)

   Materials/MaterialAttributeDefinitionMap.h  

static const FMaterialCustomOutputAttributeDefintion * GetCustomAttribute ( const FString& AttributeName
)

 Returns the first custom attribute definition that has the specificed attribute name Materials/MaterialAttributeDefinitionMap.h  

static const FMaterialCustomOutputAttributeDefintion * GetCustomAttribute ( const FGuid& AttributeID
)

 Returns the first custom attribute definition that has the specificed attribute AttributeID Materials/MaterialAttributeDefinitionMap.h  

static FGuid GetCustomAttributeID ( const FString& AttributeName
)

 Returns the first custom attribute ID that has the specificed attribute name Materials/MaterialAttributeDefinitionMap.h  

static void GetCustomAttributeList ( TArray< FMaterialCustomOutputAttributeDefintion >& CustomAttributeList
)

 Returns a list of registered custom attributes Materials/MaterialAttributeDefinitionMap.h  

static uint64 GetCustomOutputNodesBitmask ( TConstArrayView< class UMaterialExpressionCustomOutput* > Expressions
)

 Returns a bitmask of all supported custom output attributes in the given array of custom output expressions Materials/MaterialAttributeDefinitionMap.h  

static FGuid GetDefaultID()

 Returns a default attribute AttributeID Materials/MaterialAttributeDefinitionMap.h  

static FVector4f GetDefaultValue ( EMaterialProperty Property
)

 Returns the default value of a material property Materials/MaterialAttributeDefinitionMap.h  

static FVector4f GetDefaultValue ( const FGuid& AttributeID
)

 Returns the default value of a material attribute Materials/MaterialAttributeDefinitionMap.h  
Returns the display name of a material attribute, accounting for overrides based on properties of a given material Materials/MaterialAttributeDefinitionMap.h  

static FText GetDisplayNameForMaterial ( const FGuid& AttributeID,
UMaterial* Material
)

 Returns the display name of a material attribute, accounting for overrides based on properties of a given material Materials/MaterialAttributeDefinitionMap.h  

static FGuid GetID ( EMaterialProperty Property
)

 Returns the attribute ID for a matching material property Materials/MaterialAttributeDefinitionMap.h  

static int32 GetIndex ( const FGuid& AttributeID
)

 Returns the bit index of this attribute in the bitmasks returned by GetBitmask(), GetConnectedMaterialAttributesBitmask() and GetCustomOutputNodesBitmask() Materials/MaterialAttributeDefinitionMap.h  

static int32 GetIndex ( EMaterialProperty Property
)

 Returns the bit index of this property in the bitmasks returned by GetBitmask(), GetConnectedMaterialAttributesBitmask() Materials/MaterialAttributeDefinitionMap.h  

static const TArray< FGuid > & GetOrderedVisibleAttributeList()

   Materials/MaterialAttributeDefinitionMap.h  

static FString GetPinNameFromShadingModelField ( FMaterialShadingModelField InShadingModels,
const TArray< TKeyValuePair< EMaterialShadingModel, FString > >& InCustomShadingModelPinNames,
const FString& InDefaultPinName
)

   Materials/MaterialAttributeDefinitionMap.h  

static EMaterialProperty GetProperty ( const FGuid& AttributeID
)

 Returns a the material property matching the specified attribute AttributeID Materials/MaterialAttributeDefinitionMap.h  
Returns the shader frequency of a material attribute Materials/MaterialAttributeDefinitionMap.h  

static EShaderFrequency GetShaderFrequency ( const FGuid& AttributeID
)

 Returns the shader frequency of a material attribute Materials/MaterialAttributeDefinitionMap.h  
Returns the value type of a material attribute Materials/MaterialAttributeDefinitionMap.h  

static EMaterialValueType GetValueType ( const FGuid& AttributeID
)

 Returns the value type of a material attribute Materials/MaterialAttributeDefinitionMap.h  

static bool IsAttributeInBitmask ( uint64 Bitmask,
EMaterialProperty Property
)

 Checks if the bit corresponding to the property/attribute is set in the bitmask Materials/MaterialAttributeDefinitionMap.h  

static bool IsAttributeInBitmask ( uint64 Bitmask,
const FGuid& AttributeID
)

 Checks if the bit corresponding to the property/attribute is set in the bitmask Materials/MaterialAttributeDefinitionMap.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page