1. Epic GamesDeveloper
  3. UMaterialFunction

UMaterialFunction

A Material Function is a collection of material expressions that can be reused in different materials

API > API/Runtime > API/Runtime/Engine

A Material Function is a collection of material expressions that can be reused in different materials

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

Syntax

UCLASS (BlueprintType, HideCategories=object, MinimalAPI)  
class UMaterialFunction : public UMaterialFunctionInterface

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMaterialFunction ( const FObjectInitializer& ObjectInitializer
)

   Materials/MaterialFunction.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllExpressionsLoadedCorrectly uint8 Whether all expressions in the function loaded correctly. Materials/MaterialFunction.h  
bEnableExecWire uint8   Materials/MaterialFunction.h
  • EditAnywhere
  • Category=MaterialFunction
bEnableNewHLSLGenerator uint8   Materials/MaterialFunction.h
  • EditAnywhere
  • Category=MaterialFunction
bExposeToLibrary uint8 Whether to list this function in the material function library, which is a window in the material editor that lists categorized functions. Materials/MaterialFunction.h
  • EditAnywhere
  • Category=MaterialFunction
  • AssetRegistrySearchable
bPrefixParameterNames uint8   Materials/MaterialFunction.h  
DependentFunctionExpressionCandidates TArray< TObjectPtr< class UMaterialExpressionMaterialFunctionCall > >   Materials/MaterialFunction.h  
Description FString Description of the function which will be displayed as a tooltip wherever the function is used. Materials/MaterialFunction.h
  • EditAnywhere
  • Category=MaterialFunction
  • AssetRegistrySearchable
EditorMaterial TObjectPtr< UMaterial > The UMaterial which represents this function while the function itself is open in the material editor. Materials/MaterialFunction.h  
LibraryCategoriesText TArray< FText > Categories that this function belongs to in the material function library. Materials/MaterialFunction.h
  • EditAnywhere
  • Category=MaterialFunction
  • AssetRegistrySearchable
MaterialGraph UMaterialGraph *   Materials/MaterialFunction.h  
ParentFunction TObjectPtr< class UMaterialFunction > Used in the material editor, points to the function asset being edited, which this function is just a preview for. Materials/MaterialFunction.h
  • Transient
PreviewBlendMode TEnumAsByte< enum EBlendMode > Determines the blend mode when previewing a material function. Materials/MaterialFunction.h
  • EditAnywhere
  • Category=Preview
  • AssetRegistrySearchable
PreviewMaterial TObjectPtr< UMaterial >   Materials/MaterialFunction.h
  • Transient
PreviewMaterialDomain TEnumAsByte< enum EMaterialDomain > The domain to use when previewing a material function. Materials/MaterialFunction.h
  • EditAnywhere
  • Category=Preview
  • AssetRegistrySearchable
UserExposedCaption FString Name of the function to be displayed on the node within the material editor instead of the asset name. Materials/MaterialFunction.h
  • EditAnywhere
  • Category=MaterialFunction
  • AssetRegistrySearchable

Protected

Name Type Remarks Include Path Unreal Specifiers
bReentrantFlag uint8 Transient flag used to track re-entrance in recursive functions like IsDependent. Materials/MaterialFunction.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AssignExpressionCollection ( const FMaterialExpressionCollection& InCollection
)

   Materials/MaterialFunction.h  

void ConvertExpressionsBetweenLegacyAndSubstrate()

 Converts legacy Material Layer Functions to utilise Substrate Materials/MaterialFunction.h  

void GetAllCustomOutputExpressions ( TArray< class UMaterialExpressionCustomOutput* >& OutCustomOutputs
) const

 Retrieves an array of all custom output expressions in a Material Function Materials/MaterialFunction.h  

TConstArrayView< TObjectPtr< UMaterialExpressionComment > > GetEditorComments()

   Materials/MaterialFunction.h  
  Materials/MaterialFunction.h  
  Materials/MaterialFunction.h  
  Materials/MaterialFunction.h  
  Materials/MaterialFunction.h  

TConstArrayView< TObjectPtr< UMaterialExpression > > GetExpressions()

   Materials/MaterialFunction.h  

bool GetReentrantFlag()

   Materials/MaterialFunction.h  

bool SetFontParameterValueEditorOnly ( FName ParameterName,
UFont* InFontValue,
int32 InFontPage
)

   Materials/MaterialFunction.h  

void SetMaterialFunctionUsage ( EMaterialFunctionUsage Usage
)

   Materials/MaterialFunction.h  

bool SetParameterValueEditorOnly ( const FName& ParameterName,
const FMaterialParameterMetadata& Meta
)

   Materials/MaterialFunction.h  

void SetReentrantFlag ( bool bIsReentrant
)

   Materials/MaterialFunction.h  

bool SetRuntimeVirtualTextureParameterValueEditorOnly ( FName ParameterName,
URuntimeVirtualTexture* InValue
)

   Materials/MaterialFunction.h  

bool SetScalarParameterValueEditorOnly ( FName ParameterName,
float InValue
)

   Materials/MaterialFunction.h  

bool SetSparseVolumeTextureParameterValueEditorOnly ( FName ParameterName,
USparseVolumeTexture* InValue
)

   Materials/MaterialFunction.h  

bool SetStaticComponentMaskParameterValueEditorOnly ( FName ParameterName,
bool R,
bool G,
bool B,
bool A,
FGuid OutExpressionGuid
)

   Materials/MaterialFunction.h  

bool SetStaticSwitchParameterValueEditorOnly ( FName ParameterName,
bool OutValue,
FGuid OutExpressionGuid
)

   Materials/MaterialFunction.h  

bool SetTextureParameterValueEditorOnly ( FName ParameterName,
UTexture* InValue
)

   Materials/MaterialFunction.h  

bool SetVectorParameterValueEditorOnly ( FName ParameterName,
FLinearColor InValue
)

   Materials/MaterialFunction.h  

virtual void UpdateDependentFunctionCandidates()

   Materials/MaterialFunction.h  

Overridden from UMaterialFunctionInterface

Name Remarks Include Path Unreal Specifiers

virtual int32 Compile ( FMaterialCompiler* Compiler,
const FFunctionExpressionOutput& Output
)

   Materials/MaterialFunction.h  

virtual void ForceRecompileForRendering ( FMaterialUpdateContext& UpdateContext,
UMaterial* InPreviewMaterial
)

   Materials/MaterialFunction.h  

virtual const UMaterialFunction * GetBaseFunction ( FMFRecursionGuard RecursionGuard
) const

   Materials/MaterialFunction.h  

virtual UMaterialFunction * GetBaseFunction ( FMFRecursionGuard RecursionGuard
)

   Materials/MaterialFunction.h  

virtual void GetDependentFunctions ( TArray< UMaterialFunctionInterface* >& DependentFunctions
) const

 Returns an array of the functions that this function is dependent on, directly or indirectly. Materials/MaterialFunction.h  

virtual const UClass * GetEditorOnlyDataClass()

   Materials/MaterialFunction.h  

virtual void GetInputsAndOutputs ( TArray< struct FFunctionExpressionInput >& OutInputs,
TArray< struct FFunctionExpressionOutput >& OutOutputs
) const

 Get the inputs and outputs that this function exposes, for a function call expression to use. Materials/MaterialFunction.h  

virtual EMaterialFunctionUsage GetMaterialFunctionUsage()

   Materials/MaterialFunction.h  

virtual UMaterialInterface * GetPreviewMaterial()

   Materials/MaterialFunction.h  

virtual FString GetUserExposedCaption ()

 Returns If returns an empty string, use the default class name for the material function. Materials/MaterialFunction.h  

virtual bool HasFlippedCoordinates()

 Checks whether a Material Function is arranged in the old style, with inputs flowing from right to left Materials/MaterialFunction.h  

virtual bool IsDependent ( UMaterialFunctionInterface* OtherFunction
)

   Materials/MaterialFunction.h  

virtual bool IsUsingNewHLSLGenerator()

   Materials/MaterialFunction.h  

virtual bool IterateDependentFunctions ( TFunctionRef< bool(UMaterialFunctionInterface*)> Predicate
) const

 Iterates all functions that this function is dependent on, directly or indrectly. Materials/MaterialFunction.h  

virtual void LinkIntoCaller ( const TArray< FFunctionExpressionInput >& CallerInputs
)

 Called during compilation before entering the function. Materials/MaterialFunction.h  

virtual void UnlinkFromCaller()

   Materials/MaterialFunction.h  

virtual void UpdateFromFunctionResource()

 Recursively update all function call expressions in this function, or in nested functions. Materials/MaterialFunction.h  

virtual void UpdateInputOutputTypes()

   Materials/MaterialFunction.h  

virtual bool ValidateFunctionUsage ( FMaterialCompiler* Compiler,
const FFunctionExpressionOutput& Output
)

   Materials/MaterialFunction.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Materials/MaterialFunction.h  

virtual void PostLoad()

   Materials/MaterialFunction.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Materials/MaterialFunction.h  

virtual void Serialize ( FArchive& Ar
)

   Materials/MaterialFunction.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

   Materials/MaterialFunction.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
LibraryCategories_DEPRECATED TArray< FString > Categories that this function belongs to in the material function library. Materials/MaterialFunction.h
  • AssetRegistrySearchable

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page