1. Epic GamesDeveloper
  3. UMaterialExpressionFunctionOutput

UMaterialExpressionFunctionOutput

API > API/Runtime > API/Runtime/Engine

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

Syntax

UCLASS (HideCategories=object, MinimalAPI)  
class UMaterialExpressionFunctionOutput : public UMaterialExpression

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMaterialExpressionFunctionOutput ( const FObjectInitializer& ObjectInitializer
)

   Materials/MaterialExpressionFunctionOutput.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
A FExpressionInput Stores the expression in the material function connected to this output. Materials/MaterialExpressionFunctionOutput.h  
bLastPreviewed uint32 Whether this output was previewed the last time this function was edited. Materials/MaterialExpressionFunctionOutput.h  
Description FString The output's description, which will be used as a tooltip on the connector in function call expressions that use this function. Materials/MaterialExpressionFunctionOutput.h
  • EditAnywhere
  • Category=MaterialExpressionFunctionOutput
  • Meta=(MultiLine=true)
Id FGuid Id of this input, used to maintain references through name changes. Materials/MaterialExpressionFunctionOutput.h  
OutputName FName The output's name, which will be drawn on the connector in function call expressions that use this function. Materials/MaterialExpressionFunctionOutput.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=MaterialExpressionFunctionOutput
SortPriority int32 Controls where the output is displayed relative to the other outputs. Materials/MaterialExpressionFunctionOutput.h
  • EditAnywhere
  • Category=MaterialExpression

Protected

Name Type Remarks Include Path Unreal Specifiers
OutputNameBackup FName Stashed data between a Pre/PostEditChange event Materials/MaterialExpressionFunctionOutput.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ConditionallyGenerateId ( bool bForce
)

 Generate the Id for this input. Materials/MaterialExpressionFunctionOutput.h  

void ValidateName()

 Validate OutputName. Must be called after OutputName is changed to prevent duplicate outputs. Materials/MaterialExpressionFunctionOutput.h  

Overridden from UMaterialExpression

Name Remarks Include Path Unreal Specifiers

virtual void Build ( MIR::FEmitter& Emitter
)

 Builds this expression's material IR. Materials/MaterialExpressionFunctionOutput.h  

virtual int32 Compile ( FMaterialCompiler* Compiler,
int32 OutputIndex
)

 Create the new shader code chunk needed for the Abs expression Materials/MaterialExpressionFunctionOutput.h  

virtual int32 CompilePreview ( FMaterialCompiler* Compiler,
int32 OutputIndex
)

   Materials/MaterialExpressionFunctionOutput.h  

virtual void GatherSubstrateMaterialInfo ( FSubstrateMaterialInfo& SubstrateMaterialInfo,
int32 OutputIndex
)

 Recursively parse nodes outputing Substrate material in order to gather all the possible shading models used in a material graph output a Substrate material. Materials/MaterialExpressionFunctionOutput.h  

virtual void GetCaption ( TArray< FString >& OutCaptions
) const

 Returns the text to display on the material expression (in the material editor). Materials/MaterialExpressionFunctionOutput.h  

virtual void GetExpressionToolTip ( TArray< FString >& OutToolTip
)

 Get a tooltip for the expression itself. Materials/MaterialExpressionFunctionOutput.h  

virtual FName GetInputName ( int32 InputIndex
) const

   Materials/MaterialExpressionFunctionOutput.h  

virtual EMaterialValueType GetInputValueType ( int32 InputIndex
)

   Materials/MaterialExpressionFunctionOutput.h  

virtual bool IsAllowedIn ( const UObject* MaterialOrFunction
) const

 Returns whether the creation of this expression is allowed in a given material or material function Materials/MaterialExpressionFunctionOutput.h  

virtual bool IsResultMaterialAttributes ( int32 OutputIndex
)

 Marks certain expression types as outputting material attributes. Materials/MaterialExpressionFunctionOutput.h  

virtual bool IsResultSubstrateMaterial ( int32 OutputIndex
)

 Marks certain expression types as outputting Substrate material. Materials/MaterialExpressionFunctionOutput.h  
A starta material is a tree with FrontMateiral being its root and BSDF being leaves, with operators in the middle. Materials/MaterialExpressionFunctionOutput.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   Materials/MaterialExpressionFunctionOutput.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Materials/MaterialExpressionFunctionOutput.h  

virtual void PostEditImport()

   Materials/MaterialExpressionFunctionOutput.h  

virtual void PostLoad()

   Materials/MaterialExpressionFunctionOutput.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Materials/MaterialExpressionFunctionOutput.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page