UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Friends | List of all members
FMaterialAttributeDefinitionMap Class Reference

#include <MaterialAttributeDefinitionMap.h>

Public Member Functions

ENGINE_API FMaterialAttributeDefinitionMap ()
 

Static Public Member Functions

static ENGINE_API int32 CompileDefaultExpression (FMaterialCompiler *Compiler, EMaterialProperty Property)
 
static ENGINE_API int32 CompileDefaultExpression (FMaterialCompiler *Compiler, const FGuid &AttributeID)
 
static ENGINE_API const FString & GetAttributeName (EMaterialProperty Property)
 
static ENGINE_API const FString & GetAttributeName (const FGuid &AttributeID)
 
static ENGINE_API FText GetDisplayNameForMaterial (EMaterialProperty Property, UMaterial *Material)
 
static ENGINE_API FText GetDisplayNameForMaterial (const FGuid &AttributeID, UMaterial *Material)
 
static ENGINE_API EMaterialValueType GetValueType (EMaterialProperty Property)
 
static ENGINE_API EMaterialValueType GetValueType (const FGuid &AttributeID)
 
static ENGINE_API FVector4f GetDefaultValue (EMaterialProperty Property)
 
static ENGINE_API FVector4f GetDefaultValue (const FGuid &AttributeID)
 
static ENGINE_API EShaderFrequency GetShaderFrequency (EMaterialProperty Property)
 
static ENGINE_API EShaderFrequency GetShaderFrequency (const FGuid &AttributeID)
 
static ENGINE_API int32 GetIndex (EMaterialProperty Property)
 
static ENGINE_API int32 GetIndex (const FGuid &AttributeID)
 
static ENGINE_API uint64 GetBitmask (EMaterialProperty Property)
 
static ENGINE_API uint64 GetBitmask (const FGuid &AttributeID)
 
static ENGINE_API bool IsAttributeInBitmask (uint64 Bitmask, EMaterialProperty Property)
 
static ENGINE_API bool IsAttributeInBitmask (uint64 Bitmask, const FGuid &AttributeID)
 
static ENGINE_API FGuid GetID (EMaterialProperty Property)
 
static ENGINE_API EMaterialProperty GetProperty (const FGuid &AttributeID)
 
static ENGINE_API MaterialAttributeBlendFunction GetBlendFunction (const FGuid &AttributeID)
 
static ENGINE_API FGuid GetDefaultID ()
 
static ENGINE_API void AppendDDCKeyString (FString &String)
 
static ENGINE_API void AppendDDCKey (FShaderKeyGenerator &KeyGen)
 
static ENGINE_API void AddCustomAttribute (const FGuid &AttributeID, UClass *ExpressionClass, const FString &AttributeName, const FString &FunctionName, int32 OutputIndex, EMaterialValueType ValueType, const FVector4 &DefaultValue, EShaderFrequency ShaderFrequency, bool bNeedsPreviousFrameEvaluation=false, MaterialAttributeBlendFunction BlendFunction=nullptr)
 
static ENGINE_API FGuid GetCustomAttributeID (const FString &AttributeName)
 
static ENGINE_API const FMaterialCustomOutputAttributeDefintion * GetCustomAttribute (const FString &AttributeName)
 
static ENGINE_API const FMaterialCustomOutputAttributeDefintion * GetCustomAttribute (const FGuid &AttributeID)
 
static ENGINE_API void GetCustomAttributeList (TArray< FMaterialCustomOutputAttributeDefintion > &CustomAttributeList)
 
static const TArray< FGuid > & GetOrderedVisibleAttributeList ()
 

Friends

class FMaterialAttributePropertyDetails
 

Detailed Description

Material property to attribute data mappings

Constructor & Destructor Documentation

◆ FMaterialAttributeDefinitionMap()

FMaterialAttributeDefinitionMap::FMaterialAttributeDefinitionMap ( )

Member Function Documentation

◆ AddCustomAttribute()

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

Appends a new attribute definition to the custom output list

◆ AppendDDCKey()

void FMaterialAttributeDefinitionMap::AppendDDCKey ( FShaderKeyGenerator &  KeyGen)
static

◆ AppendDDCKeyString()

void FMaterialAttributeDefinitionMap::AppendDDCKeyString ( FString &  String)
static

Appends a hash of the property map intended for use with the DDC key

◆ CompileDefaultExpression() [1/2]

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

Compiles the default expression for a material attribute

◆ CompileDefaultExpression() [2/2]

int32 FMaterialAttributeDefinitionMap::CompileDefaultExpression ( FMaterialCompiler *  Compiler,
EMaterialProperty  Property 
)
static

Compiles the default expression for a material attribute

◆ GetAttributeName() [1/2]

const FString & FMaterialAttributeDefinitionMap::GetAttributeName ( const FGuid &  AttributeID)
static

Returns the display name of a material attribute

◆ GetAttributeName() [2/2]

const FString & FMaterialAttributeDefinitionMap::GetAttributeName ( EMaterialProperty  Property)
static

Returns the display name of a material attribute

◆ GetBitmask() [1/2]

uint64 FMaterialAttributeDefinitionMap::GetBitmask ( const FGuid &  AttributeID)
static

Returns a bitmask with just the bit corresponding to this attribute set

◆ GetBitmask() [2/2]

uint64 FMaterialAttributeDefinitionMap::GetBitmask ( EMaterialProperty  Property)
static

Returns a bitmask with just the bit corresponding to this property set

◆ GetBlendFunction()

MaterialAttributeBlendFunction FMaterialAttributeDefinitionMap::GetBlendFunction ( const FGuid &  AttributeID)
static

Returns the custom blend function of a material attribute

◆ GetCustomAttribute() [1/2]

const FMaterialCustomOutputAttributeDefintion * FMaterialAttributeDefinitionMap::GetCustomAttribute ( const FGuid &  AttributeID)
static

Returns the first custom attribute definition that has the specificed attribute AttributeID

◆ GetCustomAttribute() [2/2]

const FMaterialCustomOutputAttributeDefintion * FMaterialAttributeDefinitionMap::GetCustomAttribute ( const FString &  AttributeName)
static

Returns the first custom attribute definition that has the specificed attribute name

◆ GetCustomAttributeID()

FGuid FMaterialAttributeDefinitionMap::GetCustomAttributeID ( const FString &  AttributeName)
static

Returns the first custom attribute ID that has the specificed attribute name

◆ GetCustomAttributeList()

void FMaterialAttributeDefinitionMap::GetCustomAttributeList ( TArray< FMaterialCustomOutputAttributeDefintion > &  CustomAttributeList)
static

Returns a list of registered custom attributes

◆ GetDefaultID()

FGuid FMaterialAttributeDefinitionMap::GetDefaultID ( )
static

Returns a default attribute AttributeID

◆ GetDefaultValue() [1/2]

FVector4f FMaterialAttributeDefinitionMap::GetDefaultValue ( const FGuid &  AttributeID)
static

Returns the default value of a material attribute

◆ GetDefaultValue() [2/2]

FVector4f FMaterialAttributeDefinitionMap::GetDefaultValue ( EMaterialProperty  Property)
static

Returns the default value of a material property

◆ GetDisplayNameForMaterial() [1/2]

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

Returns the display name of a material attribute, accounting for overrides based on properties of a given material

◆ GetDisplayNameForMaterial() [2/2]

FText FMaterialAttributeDefinitionMap::GetDisplayNameForMaterial ( EMaterialProperty  Property,
UMaterial *  Material 
)
static

Returns the display name of a material attribute, accounting for overrides based on properties of a given material

◆ GetID()

FGuid FMaterialAttributeDefinitionMap::GetID ( EMaterialProperty  Property)
static

Returns the attribute ID for a matching material property

◆ GetIndex() [1/2]

int32 FMaterialAttributeDefinitionMap::GetIndex ( const FGuid &  AttributeID)
static

Returns the bit index of this attribute in the bitmasks returned by GetBitmask(), GetConnectedMaterialAttributesBitmask() and GetCustomOutputNodesBitmask()

◆ GetIndex() [2/2]

int32 FMaterialAttributeDefinitionMap::GetIndex ( EMaterialProperty  Property)
static

Returns the bit index of this property in the bitmasks returned by GetBitmask(), GetConnectedMaterialAttributesBitmask()

◆ GetOrderedVisibleAttributeList()

static const TArray< FGuid > & FMaterialAttributeDefinitionMap::GetOrderedVisibleAttributeList ( )
inlinestatic

◆ GetProperty()

EMaterialProperty FMaterialAttributeDefinitionMap::GetProperty ( const FGuid &  AttributeID)
static

Returns a the material property matching the specified attribute AttributeID

◆ GetShaderFrequency() [1/2]

EShaderFrequency FMaterialAttributeDefinitionMap::GetShaderFrequency ( const FGuid &  AttributeID)
static

Returns the shader frequency of a material attribute

◆ GetShaderFrequency() [2/2]

EShaderFrequency FMaterialAttributeDefinitionMap::GetShaderFrequency ( EMaterialProperty  Property)
static

Returns the shader frequency of a material attribute

◆ GetValueType() [1/2]

EMaterialValueType FMaterialAttributeDefinitionMap::GetValueType ( const FGuid &  AttributeID)
static

Returns the value type of a material attribute

◆ GetValueType() [2/2]

EMaterialValueType FMaterialAttributeDefinitionMap::GetValueType ( EMaterialProperty  Property)
static

Returns the value type of a material attribute

◆ IsAttributeInBitmask() [1/2]

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

Checks if the bit corresponding to the property/attribute is set in the bitmask

◆ IsAttributeInBitmask() [2/2]

bool FMaterialAttributeDefinitionMap::IsAttributeInBitmask ( uint64  Bitmask,
EMaterialProperty  Property 
)
static

Checks if the bit corresponding to the property/attribute is set in the bitmask

Friends And Related Symbol Documentation

◆ FMaterialAttributePropertyDetails

friend class FMaterialAttributePropertyDetails
friend
The documentation for this class was generated from the following files: