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 > API/Runtime/Engine/Materials

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Materials/MaterialFunction.h
Include #include "Materials/MaterialFunction.h"

Syntax

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

Remarks

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

Variables

  Type Name Description
Public variable uint8: 1 bAllExpressionsLoadedCorrectly Whether all expressions in the function loaded correctly.
Public variable UProperty Category, EditAnywhere uint8: 1 bEnableExecWire  
Public variable UProperty Category, EditAnywhere uint8: 1 bEnableNewHLSLGenerator  
Public variable UProperty Category, EditAnywhere assetregistrysearchable uint8: 1 bExposeToLibrary Whether to list this function in the material function library, which is a window in the material editor that lists categorized functions.
Public variable UProperty Category, EditAnywhere uint8: 1 bPrefixParameterNames If true, parameters in this function will have a prefix added to their group name.
Public variable UProperty TArray< TObjectPtr< class UMaterialExpressionMaterialFunctionCall > > DependentFunctionExpressionCandidates  
Public variable UProperty Category, EditAnywhere assetregistrysearchable FString Description Description of the function which will be displayed as a tooltip wherever the function is used.
Public variable TObjectPtr< UMaterial > EditorMaterial The UMaterial which represents this function while the function itself is open in the material editor.
Public variable UProperty Category, EditAnywhere assetregistrysearchable TArray< FText > LibraryCategoriesText Categories that this function belongs to in the material function library.
Public variable UMaterialGraph * MaterialGraph  
Public variable UProperty Transient TObjectPtr< class UMaterialFunction > ParentFunction Used in the material editor, points to the function asset being edited, which this function is just a preview for.
Public variable UProperty Category, EditAnywhere assetregistrysearchable TEnumAsByte< enum EBlendMode > PreviewBlendMode Determines the blend mode when previewing a material function.
Public variable UProperty Transient TObjectPtr< UMaterial > PreviewMaterial  
Public variable UProperty Category, EditAnywhere assetregistrysearchable FString UserExposedCaption Name of the function to be displayed on the node within the material editor instead of the asset name.

Constructors

  Type Name Description
Public function  

UMaterialFunction ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Public function void  
Public function Static void

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

  
Public function Const TConstArrayView< TObjectPtr< UMaterialExpressionComment > >  
Public function Const const UMaterialFunctionEditorOnlyData *  
Public function UMaterialFunctionEditorOnlyData *  
Public function Const const FMaterialExpressionCollection &  
Public function FMaterialExpressionCollection &  
Public function Const UMaterialExpressionExecBegin *  
Public function Const UMaterialExpressionExecEnd *  
Public function Const TConstArrayView< TObjectPtr< UMaterialExpression > >  
Public function Const bool  
Public function bool

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

  
Public function void  
Public function bool

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

  
Public function void

SetReentrantFlag ( bool bIsReentrant
)

  
Public function bool  
Public function bool

SetScalarParameterValueEditorOnly ( FName ParameterName,
float InValue
)

  
Public function bool  
Public function bool

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

  
Public function bool

SetStaticSwitchParameterValueEditorOnly ( FName ParameterName,
bool OutValue,
FGuid OutExpressionGuid
)

  
Public function bool

SetTextureParameterValueEditorOnly ( FName ParameterName,
UTexture* InValue
)

  
Public function bool  
Public function Virtual void  

Overridden from UMaterialFunctionInterface

  Type Name Description
Public function Virtual int32

Compile ( FMaterialCompiler* Compiler,
const FFunctionExpressionOutput& Output
)

  
Public function Virtual void

ForceRecompileForRendering ( FMaterialUpdateContext& UpdateContext,
UMaterial* InPreviewMaterial
)

  
Public function Virtual Const const UMaterialFunction *

GetBaseFunction ( FMFRecursionGuard RecursionGuard
)

  
Public function Virtual UMaterialFunction *

GetBaseFunction ( FMFRecursionGuard RecursionGuard
)

  
Public function Virtual Const void Returns an array of the functions that this function is dependent on, directly or indirectly.
Public function Virtual Const const UClass *  
Public function Virtual Const void

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

 Get the inputs and outputs that this function exposes, for a function call expression to use.
Public function Virtual EMaterialFunctionUsage  
Public function Virtual UMaterialInterface *  
Public function Virtual Const FString Returns If returns an empty string, use the default class name for the material 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
)

 Called during compilation before entering the function.
Public function Virtual void  
Public function Virtual void Recursively update all function call expressions in this function, or in nested functions.
Public function Virtual void  
Public function Virtual bool  

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable UProperty assetregistrysearchable TArray< FString > LibraryCategories_DEPRECATED Categories that this function belongs to in the material function library.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page