Navigation
Unreal Engine C++ API Reference > Runtime > Engine > Materials
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMaterialExpression
- UMaterialExpressionFunctionInput
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Materials/MaterialExpressionFunctionInput.h |
| Include | #include "Materials/MaterialExpressionFunctionInput.h" |
Syntax
class UMaterialExpressionFunctionInput : public UMaterialExpression
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
uint32: 1 | bCompilingFunctionPreview | True when this expression is being compiled in a function preview, false when this expression is being compiled into a material that uses the function. |
 |
uint32: 1 | bUsePreviewValueAsDefault | Whether to use the preview value or texture as the default value for this input. |
 |
FString | Description | The input's description, which will be used as a tooltip on the connector in function call expressions that use this function. |
 |
FExpressionInput | EffectivePreviewDuringCompile | The Preview input to use during compilation from another material, when bCompilingFunctionPreview is false. |
 |
FGuid | Id | Id of this input, used to maintain references through name changes. |
 |
FName | InputName | The input's name, which will be drawn on the connector in function call expressions that use this function. |
 |
TEnumAsByte< enum EFunctionInputType > | InputType | Type of this input. |
 |
FExpressionInput | Preview | Used for previewing when editing the function, or when bUsePreviewValueAsDefault is enabled. |
 |
FVector4f | PreviewValue | Value used to preview this input when editing the material function. |
 |
int32 | SortPriority | Controls where the input is displayed relative to the other inputs. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UMaterialExpressionFunctionInput
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | ConditionallyGenerateId
(
bool bForce |
Generate the Id for this input. |
 |
UMaterialExpression * | Returns the appropriate preview expression when compiling a function or material preview. | |
 |
void | ValidateName () |
Validate InputName. Must be called after InputName is changed to prevent duplicate inputs. |
Overridden from UMaterialExpression
| Type | Name | Description | |
|---|---|---|---|
  |
int32 | Compile
(
FMaterialCompiler* Compiler, |
Create the new shader code chunk needed for the Abs expression |
  |
int32 | CompilePreview
(
FMaterialCompiler* Compiler, |
|
  |
void | GatherStrataMaterialInfo
(
FStrataMaterialInfo& StrataMaterialInfo, |
Recursively parse nodes outputing strata material in order to gather all the possible shading models used in a material graph output a Strata material. |
   |
bool | GenerateHLSLExpression
(
FMaterialHLSLGenerator& Generator, |
|
   |
void | GetCaption
(
TArray< FString >& OutCaptions |
Returns the text to display on the material expression (in the material editor). |
  |
void | GetExpressionToolTip
(
TArray< FString >& OutToolTip |
Get a tooltip for the expression itself. |
  |
uint32 | GetInputType
(
int32 InputIndex |
|
  |
uint32 | GetOutputType
(
int32 OutputIndex |
|
  |
bool | IsResultMaterialAttributes
(
int32 OutputIndex |
Marks certain expression types as outputting material attributes. |
  |
bool | IsResultStrataMaterial
(
int32 OutputIndex |
Marks certain expression types as outputting Strata material. |
  |
FStrataOperator * | StrataGenerateMaterialTopologyTree
(
FMaterialCompiler* Compiler, |
A starta material is a tree with FrontMateiral being its root and BSDF being leaves, with operators in the middle. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostDuplicate
(
bool bDuplicateForPIE |
Called after duplication & serialization and before PostLoad. |
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization | |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
  |
void | PreEditChange
(
FProperty* PropertyAboutToChange |
This is called when a property is about to be modified externally |