UMaterialFunctionInstance

A material function instance defines parameter overrides for a parent material function.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Materials/MaterialFunctionInstance.h

Include

#include "Materials/MaterialFunctionInstance.h"

Syntax

class UMaterialFunctionInstance : public UMaterialFunctionInterface

Remarks

A material function instance defines parameter overrides for a parent material function.

Variables

Name Description

Public variable

UMaterialFuncti ...

 

Base

Base function.

Public variable

TArray < struct ...

 

FontParameterValues

Font parameters.

Public variable

UMaterialFuncti ...

 

Parent

Parent function.

Protected variable

UMaterialInstan ...

 

PreviewMaterial

Public variable

TArray < struct ...

 

RuntimeVirtualTextureParameterValues

Runtime virtual texture parameters.

Public variable

TArray < struct ...

 

ScalarParameterValues

Scalar parameters.

Public variable

TArray < struct ...

 

StaticComponentMaskParameterValues

Static component mask parameters.

Public variable

TArray < struct ...

 

StaticSwitchParameterValues

Static switch parameters.

Public variable

TArray < struct ...

 

TextureParameterValues

Texture parameters.

Public variable

TArray < struct ...

 

VectorParameterValues

Vector parameters.

Constructors

Name Description

Public function

UMaterialFunctionInstance

(
    const FObjectInitializer & ObjectIn...
)

Functions

Overridden from UMaterialFunctionInterface

Name Description

Public function Virtual

int32

 

Compile

(
    FMaterialCompiler * Compiler,
    const FFunctionExpressionOutput & O...
)

Public function Virtual

UMaterialFun ...

 

GetBaseFunction()

Public function Virtual Const

const UMater ...

 

GetBaseFunction()

Public function Virtual Const

void

 

GetDependentFunctions

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

Public function Virtual Const

const FStrin ...

 

GetDescription()

Public function Virtual Const

const TArray ...

 

GetFunctionExpressions()

Public function Virtual Const

void

 

GetInputsAndOutputs

(
    TArray < struct FFunctionExpressionI ...,
    TArray < struct FFunctionExpressionO ...
)

Public function Virtual

EMaterialFun ...

 

GetMaterialFunctionUsage()

Public function Virtual

UMaterialInt ...

 

GetPreviewMaterial()

Public function Virtual Const

bool

 

GetReentrantFlag()

Public function Virtual Const

bool

 

HasFlippedCoordinates()

Checks whether a Material Function is arranged in the old style, with inputs flowing from right to left

Public function Virtual

bool

 

IsDependent

(
    UMaterialFunctionInterface * Ot...
)

Public function Virtual Const

bool

 

IterateDependentFunctions

(
    TFunctionRef < bool ...
)

Iterates all functions that this function is dependent on, directly or indrectly.

Public function Virtual

void

 

LinkIntoCaller

(
    const TArray < FFunctionExpressionIn ...
)

Public function Virtual

bool

 

OverrideNamedFontParameter

(
    const FHashedMaterialParameterInfo ...,
    UFont *& OutFontValue,
    int32 & OutFontPage
)

Public function Virtual

bool

 

OverrideNamedRuntimeVirtualTextureParameter

(
    const FHashedMaterialParameterInfo ...,
    URuntimeVirtualTexture *& OutVa...
)

Public function Virtual

bool

 

OverrideNamedScalarParameter

(
    const FHashedMaterialParameterInfo ...,
    float& OutValue
)

Public function Virtual

bool

 

OverrideNamedStaticComponentMaskParameter

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

Public function Virtual

bool

 

OverrideNamedStaticSwitchParameter

(
    const FHashedMaterialParameterInfo ...,
    bool & OutValue,
    FGuid & OutExpressionGuid
)

Public function Virtual

bool

 

OverrideNamedTextureParameter

(
    const FHashedMaterialParameterInfo ...,
    UTexture *& OutValue
)

Public function Virtual

bool

 

OverrideNamedVectorParameter

(
    const FHashedMaterialParameterInfo ...,
    FLinearColor & OutValue
)

Public function Virtual

void

 

SetReentrantFlag

(
    const bool bIsReentrant
)

Public function Virtual

void

 

UnlinkFromCaller()

Public function Virtual

void

 

UpdateFromFunctionResource()

Public function Virtual

void

 

UpdateInputOutputTypes()

Public function Virtual

bool

 

ValidateFunctionUsage

(
    FMaterialCompiler * Compiler,
    const FFunctionExpressionOutput & O...
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback