1. Epic GamesDeveloper
  3. UMaterialExpressionFunctionInput

UMaterialExpressionFunctionInput

API > API/Runtime > API/Runtime/Engine

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

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMaterialExpressionFunctionInput ( const FObjectInitializer& ObjectInitializer
)

   Materials/MaterialExpressionFunctionInput.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BlendInputRelevance TEnumAsByte< enum EBlendInputRelevance > Marks that this input is necessary for blend function use Materials/MaterialExpressionFunctionInput.h
  • EditAnywhere
  • Category=MaterialExpressionFunctionInput
bUsePreviewValueAsDefault uint32 Whether to use the preview value or texture as the default value for this input. Materials/MaterialExpressionFunctionInput.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=MaterialExpressionFunctionInput
Description FString The input's description, which will be used as a tooltip on the connector in function call expressions that use this function. Materials/MaterialExpressionFunctionInput.h
  • EditAnywhere
  • Category=MaterialExpressionFunctionInput
Id FGuid Id of this input, used to maintain references through name changes. Materials/MaterialExpressionFunctionInput.h  
InputName FName The input's name, which will be drawn on the connector in function call expressions that use this function. Materials/MaterialExpressionFunctionInput.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=MaterialExpressionFunctionInput
InputType TEnumAsByte< enum EFunctionInputType > Type of this input. Materials/MaterialExpressionFunctionInput.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=MaterialExpressionFunctionInput
Preview FExpressionInput Used for previewing when editing the function, or when bUsePreviewValueAsDefault is enabled. Materials/MaterialExpressionFunctionInput.h
  • Meta=(RequiredInput="false")
PreviewValue FVector4f Value used to preview this input when editing the material function. Materials/MaterialExpressionFunctionInput.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=MaterialExpressionFunctionInput
  • Meta=(OverridingInputProperty="Preview")
SortPriority int32 Controls where the input is displayed relative to the other inputs. Materials/MaterialExpressionFunctionInput.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=MaterialExpression

Protected

Name Type Remarks Include Path Unreal Specifiers
EffectivePreviewDuringCompile TArray< FExpressionInput * > Cascading preview inputs to use when compiling from another material and/or function Materials/MaterialExpressionFunctionInput.h  
InputNameBackup FName Stashed data between a Pre/PostEditChange event Materials/MaterialExpressionFunctionInput.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
These create and delete new FExpression objects on the heap, but are public to allow creation and removal from external systems. Materials/MaterialExpressionFunctionInput.h  

void ConditionallyGenerateId ( bool bForce
)

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

void RemoveLastEffectivePreviewDuringCompile()

   Materials/MaterialExpressionFunctionInput.h  

void ValidateName()

 Validate InputName. Must be called after InputName is changed to prevent duplicate inputs. Materials/MaterialExpressionFunctionInput.h  

Overridden from UMaterialExpression

Name Remarks Include Path Unreal Specifiers

virtual void Build ( MIR::FEmitter& Emitter
)

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

virtual int32 Compile ( FMaterialCompiler* Compiler,
int32 OutputIndex
)

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

virtual int32 CompilePreview ( FMaterialCompiler* Compiler,
int32 OutputIndex
)

   Materials/MaterialExpressionFunctionInput.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/MaterialExpressionFunctionInput.h  

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

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

virtual void GetExpressionToolTip ( TArray< FString >& OutToolTip
)

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

virtual EMaterialValueType GetInputValueType ( int32 InputIndex
)

   Materials/MaterialExpressionFunctionInput.h  

virtual EMaterialValueType GetOutputValueType ( int32 OutputIndex
)

   Materials/MaterialExpressionFunctionInput.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/MaterialExpressionFunctionInput.h  

virtual bool IsResultMaterialAttributes ( int32 OutputIndex
)

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

virtual bool IsResultSubstrateMaterial ( int32 OutputIndex
)

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   Materials/MaterialExpressionFunctionInput.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Materials/MaterialExpressionFunctionInput.h  

virtual void PostEditImport()

   Materials/MaterialExpressionFunctionInput.h  

virtual void PostLoad()

   Materials/MaterialExpressionFunctionInput.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Materials/MaterialExpressionFunctionInput.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString GetInputTypeDisplayName ( EFunctionInputType InputType
)

   Materials/MaterialExpressionFunctionInput.h  

static EFunctionInputType GetInputTypeFromMaterialType ( EMaterialValueType MaterialType
)

   Materials/MaterialExpressionFunctionInput.h  

static EMaterialValueType GetMaterialTypeFromInputType ( EFunctionInputType InputType
)

   Materials/MaterialExpressionFunctionInput.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bCompilingFunctionPreview_DEPRECATED uint32   Materials/MaterialExpressionFunctionInput.h
  • Transient
  • Meta=(DeprecatedProperty, DeprecationMessage="bCompilingFunctionPreview has been removed from function inputs and has no functional usage, it has been replaced by automatic state tracking between function calls.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page