Navigation
Unreal Engine C++ API Reference > Runtime > Engine > Materials
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMaterialFunctionInterface
- UMaterialFunction
- UMaterialFunctionMaterialLayer
- UMaterialFunctionMaterialLayerBlend
References
Module | Engine |
Header | /Engine/Source/Runtime/Engine/Classes/Materials/MaterialFunction.h |
Include | #include "Materials/MaterialFunction.h" |
Syntax
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 | |
---|---|---|---|
![]() |
uint8: 1 | bEnableExecWire | |
![]() |
uint8: 1 | bEnableNewHLSLGenerator | |
![]() |
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. |
![]() |
uint8: 1 | bPrefixParameterNames | If true, parameters in this function will have a prefix added to their group name. |
![]() |
TArray< TObjectPtr< class UMaterialExpressionMaterialFunctionCall > > | DependentFunctionExpressionCandidates | |
![]() |
FString | Description | Description of the function which will be displayed as a tooltip wherever the function is used. |
![]() |
TObjectPtr< UMaterial > | EditorMaterial | The UMaterial which represents this function while the function itself is open in the material editor. |
![]() |
TArray< FText > | LibraryCategoriesText | Categories that this function belongs to in the material function library. |
![]() |
UMaterialGraph * | MaterialGraph | |
![]() |
TObjectPtr< class UMaterialFunction > | ParentFunction | Used in the material editor, points to the function asset being edited, which this function is just a preview for. |
![]() |
TEnumAsByte< enum EBlendMode > | PreviewBlendMode | Determines the blend mode when previewing a material function. |
![]() |
TObjectPtr< UMaterial > | PreviewMaterial | |
![]() |
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 | |
---|---|---|---|
![]() |
UMaterialFunction
(
const FObjectInitializer& ObjectInitializer |
Functions
Overridden from UMaterialFunctionInterface
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
int32 | Compile
(
FMaterialCompiler* Compiler, |
|
![]() ![]() |
void | ForceRecompileForRendering
(
FMaterialUpdateContext& UpdateContext, |
|
![]() ![]() ![]() |
const UMaterialFunction * | GetBaseFunction
(
FMFRecursionGuard RecursionGuard |
|
![]() ![]() |
UMaterialFunction * | GetBaseFunction
(
FMFRecursionGuard RecursionGuard |
|
![]() ![]() ![]() |
void | GetDependentFunctions
(
TArray< UMaterialFunctionInterface* >& DependentFunctions |
Returns an array of the functions that this function is dependent on, directly or indirectly. |
![]() ![]() ![]() |
const UClass * | ||
![]() ![]() ![]() |
void | GetInputsAndOutputs
(
TArray< struct FFunctionExpressionInput >& OutInputs, |
Get the inputs and outputs that this function exposes, for a function call expression to use. |
![]() ![]() |
EMaterialFunctionUsage | ||
![]() ![]() |
UMaterialInterface * | ||
![]() ![]() ![]() |
FString | Returns If returns an empty string, use the default class name for the material function. | |
![]() ![]() ![]() |
bool | Checks whether a Material Function is arranged in the old style, with inputs flowing from right to left | |
![]() ![]() |
bool | IsDependent
(
UMaterialFunctionInterface* OtherFunction |
|
![]() ![]() ![]() |
bool | ||
![]() ![]() ![]() |
bool | ||
![]() ![]() ![]() |
bool | IterateDependentFunctions
(
TFunctionRef< bool(UMaterialFunctionInterface*)> Predicate |
Iterates all functions that this function is dependent on, directly or indrectly. |
![]() ![]() |
void | LinkIntoCaller
(
const TArray< FFunctionExpressionInput >& CallerInputs |
Called during compilation before entering the function. |
![]() ![]() |
void | ||
![]() ![]() |
void | Recursively update all function call expressions in this function, or in nested functions. | |
![]() ![]() |
void | ||
![]() ![]() |
bool | ValidateFunctionUsage
(
FMaterialCompiler* Compiler, |
Overridden from UObject
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
![]() ![]() |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
![]() ![]() |
void | Handles reading, writing, and reference collecting using FArchive. |
Deprecated Variables
Type | Name | Description | |
---|---|---|---|
![]() |
TArray< FString > | LibraryCategories_DEPRECATED | Categories that this function belongs to in the material function library. |