1. Epic GamesDeveloper
  3. UMaterialFunctionInterface

UMaterialFunctionInterface

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Materials

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Materials/MaterialFunctionInterface.h
Include #include "Materials/MaterialFunctionInterface.h"

Syntax

class UMaterialFunctionInterface : public UObject

Remarks

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

Variables

  Type Name Description
Public variable uint32 CombinedInputTypes  
Public variable uint32 CombinedOutputTypes  
Protected variable TObjectPtr< UMaterialFunctionInterfaceEditorOnlyData > EditorOnlyData  
Protected variable EMaterialFunctionUsage MaterialFunctionUsage The intended usage of this function, required for material layers.
Public variable FGuid StateId Used by materials using this function to know when to recompile.
Public variable TObjectPtr< class UThumbnailInfo > ThumbnailInfo Information for thumbnail rendering

Constructors

  Type Name Description
Public function  

UMaterialFunctionInterface ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual int32

Compile ( FMaterialCompiler* Compiler,
const FFunctionExpressionOutput& Output
)

  
Protected function Virtual UMaterialFunctionInterfaceEditorOnlyData *  
Public function Static void

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

  
Public function Virtual void

ForceRecompileForRendering ( FMaterialUpdateContext& UpdateContext,
UMaterial* InPreviewMaterial
)

  
Public function void

GetAllExpressionsOfType ( TArray< ExpressionType* >& OutExpressions,
const bool bRecursive
)

 Get all expressions of the requested type, recursing through any function expressions in the function
Public function Virtual Const const UMaterialFunction *

GetBaseFunction ( FMFRecursionGuard RecursionGuard
)

  
Public function Virtual UMaterialFunction *

GetBaseFunction ( FMFRecursionGuard RecursionGuard
)

  
Public function Const const UMaterialFunctionInterface * Returns GetBaseFunction() as a UMaterialFunctionInterface, useful if MaterialFunction.h hasn't been included yet, and implicit conversion to UMaterialInterface isn't availiable
Public function UMaterialFunctionInterface * Returns GetBaseFunction() as a UMaterialFunctionInterface, useful if MaterialFunction.h hasn't been included yet, and implicit conversion to UMaterialInterface isn't availiable
Public function Virtual Const void Returns an array of the functions that this function is dependent on, directly or indirectly.
Public function Const const FString &  
Public function UMaterialFunctionInterfaceEditorOnlyData *  
Public function Const const UMaterialFunctionInterfaceEditorOnlyData *  
Protected function Virtual Const const UClass *  
Public function Const TConstArrayView< TObjectPtr< UMaterialExpression > >  
Public function Virtual Const void

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

  
Public function Virtual EMaterialFunctionUsage  
Public function bool

GetNamedParameterOfType ( const FHashedMaterialParameterInfo& ParameterInfo,
ExpressionType*& Parameter,
UMaterialFunctionInterface** OwningFunction
)

 Finds the first matching parameter by name and type
Public function Virtual Const bool

GetParameterOverrideValue ( EMaterialParameterType Type,
const FName& ParameterName,
FMaterialParameterMetadata& OutValue,
FMFRecursionGuard RecursionGuard
)

  
Public function Virtual UMaterialInterface *  
Public function Const bool  
Public function Virtual Const FString Returns If returns an empty string, use the default class name for the material function.
Public function bool Get all expressions of the requested type, recursing through any function expressions in the function
Public function Virtual Const bool Checks whether a Material Function is arranged in the old style, with inputs flowing from right to left
Public function Virtual bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool Iterates all functions that this function is dependent on, directly or indrectly.
Public function Virtual void

LinkIntoCaller ( const TArray< FFunctionExpressionInput >& CallerInputs
)

  
Public function bool

OverrideNamedFontParameter ( const FHashedMaterialParameterInfo& ParameterInfo,
UFont*& OutFontValue,
int32& OutFontPage
)

  
Public function bool

OverrideNamedRuntimeVirtualTextureParameter ( const FHashedMaterialParameterInfo& ParameterInfo,
URuntimeVirtualTexture*& OutValue
)

  
Public function bool

OverrideNamedScalarParameter ( const FHashedMaterialParameterInfo& ParameterInfo,
float& OutValue
)

  
Public function bool

OverrideNamedSparseVolumeTextureParameter ( const FHashedMaterialParameterInfo& ParameterInfo,
USparseVolumeTexture*& OutValue
)

  
Public function bool

OverrideNamedStaticComponentMaskParameter ( const FHashedMaterialParameterInfo& ParameterInfo,
bool& OutR,
bool& OutG,
bool& OutB,
bool& OutA,
FGuid& OutExpressionGuid
)

  
Public function bool

OverrideNamedStaticSwitchParameter ( const FHashedMaterialParameterInfo& ParameterInfo,
bool& OutValue,
FGuid& OutExpressionGuid
)

  
Public function bool

OverrideNamedTextureParameter ( const FHashedMaterialParameterInfo& ParameterInfo,
UTexture*& OutValue
)

  
Public function bool

OverrideNamedVectorParameter ( const FHashedMaterialParameterInfo& ParameterInfo,
FLinearColor& OutValue
)

  
Public function void

SetReentrantFlag ( bool bIsReentrant
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function bool

UpdateParameterSet ( ParameterType& Parameter
)

 Returns if any of the matching parameters have changed
Public function Virtual bool  

Overridden from UObject

  Type Name Description
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual bool

Rename ( const TCHAR* NewName,
UObject* NewOuter,
ERenameFlags Flags
)

 Rename this object to a unique name, or change its outer.

Deprecated Functions

  Type Name Description
Public function Const TConstArrayView< TObjectPtr< UMaterialExpression > > Use GetExpressions()

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page