FEmitter

The [FEmitter](API\Runtime\Engine\FEmitter) is a helper object responsible for emitting MIR values and instructions.

API > API/Runtime > API/Runtime/Engine

The FEmitter is a helper object responsible for emitting MIR values and instructions. It is primarily used within UMaterialExpression::Build() implementations to lower the high-level semantics of a material expression into corresponding lower-level MIR nodes.

During the emission process, the emitter automatically performs various simplifications and constant folding optimizations where possible.

An instance of the emitter is created and managed by the FMaterialIRModuleBuilder. This instance is then passed to the UMaterialExpression::Build() functions so that they can emit their corresponding IR values.

IMPORTANT: Users should not assume the exact MIR::FType of the FValue* returned by EmitXXX() functions. The emitter is free to optimize operations, which may result in a returned value having a different type than naively expected (e.g., folding an operation into a constant).

The emitter handles invalid inputs gracefully. If an operation is attempted with invalid arguments (e.g., acting on arguments of unexpected types), the emitter automatically reports an error and returns the MIR::FPoison value. Furthermore, all EmitXXX() functions are robust to receiving MIR::FPoison as input; they will simply propagate the poison value without attempting the operation.

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

Syntax

class FEmitter

Constructors

Name Remarks Include Path Unreal Specifiers

FEmitter()

   Materials/MaterialIREmitter.h  

Structs

Name Remarks
FFunctionHLSLKeyFuncs Key funcs for deduplicating HLSL functions by content.
FPrivate  
FValueKeyFuncs  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BaseMaterial UMaterial * The base material of the interface being translated (could be different from the interface if the interface is a material instance). Materials/MaterialIREmitter.h  
bExpressionRequestsInputsOnDemand bool Whether the current expression opts into on-demand input resolution via MIR_OnDemandInputRequest metadata. Materials/MaterialIREmitter.h  
BuilderImpl FMaterialIRModuleBuilderImpl * Pointer to the builder internal implementation. Materials/MaterialIREmitter.h  
Expression UMaterialExpression * The current expression being built (set by the builder). Materials/MaterialIREmitter.h  
FalseConstant FValue * Global "false" constant. Materials/MaterialIREmitter.h  
FMaterialIRModuleBuilder friend   Materials/MaterialIREmitter.h  
FMaterialIRModuleBuilderImpl friend   Materials/MaterialIREmitter.h  
FunctionHLSLSet TSet< FFunctionHLSL *, FFunctionHLSLKeyFuncs > The set of unique HLSL functions emitted so far, used to deduplicate identical function definitions. Materials/MaterialIREmitter.h  
MaterialInterface UMaterialInterface * The material interface being translated. Materials/MaterialIREmitter.h  
Module FMaterialIRModule * The IR module being built. Materials/MaterialIREmitter.h  
State EState Current emitter state for the expression being built. Materials/MaterialIREmitter.h  
StaticParameterSet const FStaticParameterSet * The set of static parameter assignments to use during this translation. Materials/MaterialIREmitter.h  
SubstrateTranslatorData Substrate::FSubstrateTranslatorData * The substrate translator common data representing the material topology. Materials/MaterialIREmitter.h  
TrueConstant FValue * Global "true" constant. Materials/MaterialIREmitter.h  
ValueSet TSet< FValue *, FValueKeyFuncs > The set of all values previously emitted. Materials/MaterialIREmitter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FValueRef Abs ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef ACos ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef ACosh ( FValueRef A
)

   Materials/MaterialIREmitter.h  
  Materials/MaterialIREmitter.h  

FValueRef Aggregate ( const UMaterialAggregate* InAggregate,
FValueRef InPrototype,
TConstArrayView< FAttributeAssignment > AttributeAssignments
)

 Constructs an aggregate value using the given type and prototype, initializing its attributes using the provided assignments. Materials/MaterialIREmitter.h  

FValueRef Aggregate ( const UMaterialAggregate* InAggregate,
FValueRef InPrototype,
TConstArrayView< FValueRef > AttributeValues
)

 Constructs an aggregate value using the given type and prototype, and initializes it with the provided list of attribute values. Materials/MaterialIREmitter.h  

FValueRef Aggregate ( const UMaterialAggregate* InAggregate
)

 Constructs an aggregate value using the provided aggregate definition. Materials/MaterialIREmitter.h  

FValueRef AnalysisError ( FType Type,
FStringView Message
)

 Emits an analysis error value. Materials/MaterialIREmitter.h  

FValueRef AnalyticalPartialDerivative ( FValueRef Value,
EDerivativeAxis Axis
)

 Computes and emits the analytical partial derivative of a give value. Materials/MaterialIREmitter.h  
  Materials/MaterialIREmitter.h  

FValueRef ASin ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef ASinh ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef ATan ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Atan2 ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef ATanh ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef BitShiftLeft ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef BitShiftRight ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef BitwiseAnd ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef BitwiseNot ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef BitwiseOr ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef BitwiseXor ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef Branch ( FValueRef Condition,
FValueRef True,
FValueRef False
)

 Emits a branch instruction. Materials/MaterialIREmitter.h  

FValueRef Builtin ( EBuiltin Id
)

 Emits an builtin value of given id and returns it. Materials/MaterialIREmitter.h  

FValueRef Call ( FFunction* Function,
TConstArrayView< FValueRef > InputArguments
)

 Emits a call to a specified user function using specified input arguments. Materials/MaterialIREmitter.h  

FValueRef CallParameterOutput ( FValueRef Call,
uint32 ParameterIndex
)

 Emits an instruction that retrieves the output parameter value from a function call. Materials/MaterialIREmitter.h  

FValueRef Cast ( FValueRef Value,
FType TargetType
)

 Casts the given value to the specified target type. Returns poison if the cast is invalid. Materials/MaterialIREmitter.h  

FValueRef CastToBool ( FValueRef Value,
int NumColumns
)

 These functions cast the given value to the a primitive scalar or column vector type of given rows. Materials/MaterialIREmitter.h  

FValueRef CastToBoolKind ( FValueRef Value
)

   Materials/MaterialIREmitter.h  

FValueRef CastToFloat ( FValueRef Value,
int NumColumns
)

   Materials/MaterialIREmitter.h  

FValueRef CastToFloatKind ( FValueRef Value
)

   Materials/MaterialIREmitter.h  

FValueRef CastToInt ( FValueRef Value,
int NumColumns
)

   Materials/MaterialIREmitter.h  

FValueRef CastToIntKind ( FValueRef Value
)

   Materials/MaterialIREmitter.h  
Casts the given primitive value to a scalar preserving the same ScalarKind. Materials/MaterialIREmitter.h  

FValueRef CastToScalarKind ( FValueRef Value,
EScalarKind ToScalarKind
)

 Casts the given primitive value to a given scalar kind, maintaining the same number of rows and columns. Materials/MaterialIREmitter.h  

FValueRef CastToVector ( FValueRef Value,
int32 NumColumns
)

 Casts the given primitive value to a row vector of specified columns preserving the same ScalarKind. Materials/MaterialIREmitter.h  

FValueRef Ceil ( FValueRef A
)

   Materials/MaterialIREmitter.h  

void CheckFeatureLevelIsAtLeast ( ERHIFeatureLevel::Type FeatureLevel
)

 Checks that the material feature level is equal or greater than the one specified. Materials/MaterialIREmitter.h  

FValueRef CheckIsAggregate ( FValueRef Value,
const UMaterialAggregate* Aggregate
)

 Validates that the value is of an aggregate type. If not, reports error and returns poison. Materials/MaterialIREmitter.h  

FValueRef CheckIsArithmetic ( FValueRef Value
)

 Validates that the value is of an arithmetic type (int or float). Reports error and returns poison otherwise. Materials/MaterialIREmitter.h  

FValueRef CheckIsBoolean ( FValueRef Value
)

 Validates that the value is of a boolean type. If not, reports an error and returns poison. Materials/MaterialIREmitter.h  

FValueRef CheckIsInteger ( FValueRef Value
)

 Validates that the value is of a integral type. If not, reports an error and returns poison. Materials/MaterialIREmitter.h  

FValueRef CheckIsMatrix ( FValueRef Value
)

 Validates that the value is a matrix. If not, reports error and returns poison. Materials/MaterialIREmitter.h  

FValueRef CheckIsPrimitive ( FValueRef Value
)

 Validates that the value is of a primitive type. If not, reports an error and returns poison. Materials/MaterialIREmitter.h  

FValueRef CheckIsScalar ( FValueRef Value
)

 Validates that the value is a scalar. If not, reports error and returns poison. Materials/MaterialIREmitter.h  

FValueRef CheckIsScalarOrVector ( FValueRef Value
)

 Validates that the value is either a scalar or a vector. Reports error and returns poison otherwise. Materials/MaterialIREmitter.h  
Retrieves the texture value flowing into given input. Materials/MaterialIREmitter.h  
Validates that the value is a vector. If not, reports error and returns poison. Materials/MaterialIREmitter.h  

FValueRef CheckIsVector ( FValueRef Value,
int32 MinNumComponents,
int32 MaxNumComponents
)

 Validates that the value is a vector of number of components between specified min/max. Materials/MaterialIREmitter.h  

void CheckMaterialDomainIsAnyOf ( TConstArrayView< EMaterialDomain > Domains
)

 Checks that the material domain is any of the ones specified. Materials/MaterialIREmitter.h  

void CheckMaterialHasUsageFlag ( EMaterialUsage UsageFlag
)

 Checks that the material has the specified usage flag. Materials/MaterialIREmitter.h  
Retrieves the value from the given input of given type kind. Materials/MaterialIREmitter.h  
  Materials/MaterialIREmitter.h  

FValueRef ConstantBool ( bool InX
)

 Returns the given constant boolean scalar. Materials/MaterialIREmitter.h  

FValueRef ConstantBool2 ( bool InX,
bool InY
)

 Emits a constant bool 2D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantBool3 ( bool InX,
bool InY,
bool InZ
)

 Emits a constant bool 3D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantBool4 ( bool InX,
bool InY,
bool InZ,
bool InW
)

 Emits a constant bool 4D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantDefault ( FType Type
)

 Emits a default value of given type (zero initialized). Materials/MaterialIREmitter.h  

FValueRef ConstantDouble ( TDouble InX
)

 Returns the given constant LWC scalar. Materials/MaterialIREmitter.h  

FValueRef ConstantDouble2 ( UE::Math::TVector2< TDouble > InValue
)

 Emits a constant double 2D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantDouble3 ( UE::Math::TVector< TDouble > InValue
)

 Emits a constant double 3D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantDouble4 ( UE::Math::TVector4< TDouble > InValue
)

 Emits a constant double 4D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantFalse()

 Returns the constant boolean scalar `false_. Materials/MaterialIREmitter.h  

FValueRef ConstantFloat ( TFloat InX
)

 Returns the given constant float scalar. Materials/MaterialIREmitter.h  

FValueRef ConstantFloat2 ( UE::Math::TVector2< TFloat > InValue
)

 Emits a constant float 2D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantFloat3 ( UE::Math::TVector< TFloat > InValue
)

 Emits a constant float 3D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantFloat4 ( UE::Math::TVector4< TFloat > InValue
)

 Emits a constant float 4D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantFromShaderValue ( const UE::Shader::FValue& InValue
)

 Converts the given UE::Shader::FValue to a MIR constant value and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantInt ( TInteger InX
)

 Returns the given constant integer scalar. Materials/MaterialIREmitter.h  

FValueRef ConstantInt2 ( UE::Math::TIntVector2< TInteger > InValue
)

 Emits a constant integer 2D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantInt3 ( UE::Math::TIntVector3< TInteger > InValue
)

 Emits a constant integer 3D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantInt4 ( UE::Math::TIntVector4< TInteger > InValue
)

 Emits a constant integer 4D column vector and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantOne ( EScalarKind Kind
)

 Emits a scalar constant value of given kind with value 1 and returns it. Materials/MaterialIREmitter.h  

FValueRef ConstantScalar ( EScalarKind Kind,
TDouble Value
)

 Casts the given float value to the given scalar kind and returns its value. Materials/MaterialIREmitter.h  

FValueRef ConstantTrue()

 Returns the constant boolean scalar `true_. Materials/MaterialIREmitter.h  

FValueRef ConstantZero ( EScalarKind Kind
)

 Emits a scalar constant value of given kind with value 0 and returns it. Materials/MaterialIREmitter.h  

FValueRef Cos ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Cosh ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Cross ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef CustomPrimitiveData ( uint32 PrimitiveDataIndex
)

 Emits a custom primitive data value with given index. Materials/MaterialIREmitter.h  

FValueRef Divide ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  
  Materials/MaterialIREmitter.h  

FValueRef Equals ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

void Error ( FValueRef Source,
FStringView Message
)

 Reports an error with given error message. Materials/MaterialIREmitter.h  

void Error ( FStringView Message
)

 Reports an error with given error message. Materials/MaterialIREmitter.h  

void Errorf ( FValueRef Source,
UE::Core::TCheckedFormatString< FString::FmtCharType, TArgs... > Format,
TArgs... Args
)

 Reports an error using printf-like format and arguments to format the error message. Materials/MaterialIREmitter.h  

void Errorf ( UE::Core::TCheckedFormatString< FString::FmtCharType, TArgs... > Format,
TArgs... Args
)

 Reports an error using printf-like format and arguments to format the error message. Materials/MaterialIREmitter.h  

FValueRef Exponential ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Exponential2 ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Extern ( TDefinition DefinitionPrototype,
TArguments... Arguments
)

 Implementation of FEmitter::Extern. Materials/MaterialIREmitter.h  

FValueRef Floor ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Fmod ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef Frac ( FValueRef A
)

   Materials/MaterialIREmitter.h  
Defines a user-specified HLSL function to embed in the generated HLSL when generated IR Module is translated to HLSL. Materials/MaterialIREmitter.h  

const UMaterial * GetBaseMaterial()

   Materials/MaterialIREmitter.h  
Gets the common type between A and B and reports an error if no such type exists. Materials/MaterialIREmitter.h  

FType GetCommonType ( TConstArrayView< FValueRef > Values
)

 Gets the common type between the specified values types. Materials/MaterialIREmitter.h  

ERHIFeatureLevel::Type GetFeatureLevel()

 Returns the target feature level the source material is translating for. Materials/MaterialIREmitter.h  

FType GetMaterialAggregateAttributeType ( const UMaterialAggregate* Aggregate,
int32 AttributeIndex
)

 Returns the type of the i-th attribute in the given material aggregate. Materials/MaterialIREmitter.h  

const UMaterialInterface * GetMaterialInterface()

   Materials/MaterialIREmitter.h  

EMaterialQualityLevel::Type GetQualityLevel()

 Returns the target quality level the source material is translating for. Materials/MaterialIREmitter.h  

EShaderPlatform GetShaderPlatform()

 Returns the shader platform the source material is translating for. Materials/MaterialIREmitter.h  

const FStaticParameterSet * GetStaticParameterSet()

   Materials/MaterialIREmitter.h  

UMaterialExpression * GetSubgraphExpression()

 Returns the expression that declared the current subgraph scope, or null if at root level. Materials/MaterialIREmitter.h  

Substrate::FSubstrateTranslatorData * GetSubstrateTranslatorData()

 Returns the Substrate translator data in use. Materials/MaterialIREmitter.h  

const ITargetPlatform * GetTargetPlatform()

 Returns the target platform the source material is translating for. Materials/MaterialIREmitter.h  

FValueRef GreaterThan ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef GreaterThanOrEquals ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef Input ( const FExpressionInput* Input
)

 Retrieves the value flowing into given input. Materials/MaterialIREmitter.h  

FValueRef InputDefault ( const FExpressionInput* Input,
FValueRef Default
)

 Try read the value flowing into given Input, and if not present use Default instead. Materials/MaterialIREmitter.h  

FValueRef InputDefaultBool ( const FExpressionInput* Input,
bool Default
)

 If the input has no value flowing in (e.g., because the input is disconnected), these DefaultXXX() functions will emit a constant value, bind it to the input, and return it. Materials/MaterialIREmitter.h  

FValueRef InputDefaultFloat ( const FExpressionInput* Input,
TFloat Default
)

   Materials/MaterialIREmitter.h  

FValueRef InputDefaultFloat2 ( const FExpressionInput* Input,
UE::Math::TVector2< TFloat > Default
)

   Materials/MaterialIREmitter.h  

FValueRef InputDefaultFloat3 ( const FExpressionInput* Input,
UE::Math::TVector< TFloat > Default
)

   Materials/MaterialIREmitter.h  

FValueRef InputDefaultFloat4 ( const FExpressionInput* Input,
UE::Math::TVector4< TFloat > Default
)

   Materials/MaterialIREmitter.h  

FValueRef InputDefaultInt ( const FExpressionInput* Input,
TInteger Default
)

   Materials/MaterialIREmitter.h  

FValueRef InputDefaultInt2 ( const FExpressionInput* Input,
UE::Math::TIntVector2< TInteger > Default
)

   Materials/MaterialIREmitter.h  

FValueRef InputDefaultInt3 ( const FExpressionInput* Input,
UE::Math::TIntVector3< TInteger > Default
)

   Materials/MaterialIREmitter.h  

FValueRef InputDefaultInt4 ( const FExpressionInput* Input,
UE::Math::TIntVector4< TInteger > Default
)

   Materials/MaterialIREmitter.h  

bool IsInvalid ()

 Returns whether the emitter is in a non-clean state (pending dependency or error). Materials/MaterialIREmitter.h  

FValueRef Length ( FValueRef A
)

   Materials/MaterialIREmitter.h  
  Materials/MaterialIREmitter.h  

FValueRef LessThan ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef LessThanOrEquals ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef Logarithm ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Logarithm10 ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Logarithm2 ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef LWCTile ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef MaterialParameterCollection ( UMaterialParameterCollection* Collection
)

 Emits a material parameter collection. Materials/MaterialIREmitter.h  

FValueRef MatrixMultiply ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  
  Materials/MaterialIREmitter.h  
  Materials/MaterialIREmitter.h  

FValueRef Modulo ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef Multiply ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

FValueRef NamedPrimitiveUniform ( FName Name,
FValueRef DefaultConstant
)

 Emits a named uniform value of primitive type. Materials/MaterialIREmitter.h  

FValueRef Negate ( FValueRef A
)

   Materials/MaterialIREmitter.h  
Emits a NOP instruction that behaves as a default value of Arg type, but will still cause Arg to be analyzed. Materials/MaterialIREmitter.h  

FValueRef Not ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef NotEquals ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  
Emits a mathematical operation instruction with given operator and arguments. Materials/MaterialIREmitter.h  
  Materials/MaterialIREmitter.h  

FEmitter & Output ( const FExpressionOutput* ExpressionOutput,
FValueRef Value
)

 Flows given Value_ out of given expression ExpressionOutput_. Materials/MaterialIREmitter.h  

FEmitter & Output ( int32 OutputIndex,
FValueRef Value
)

 Flows given Value_ out of the expression output with given OutputIndex_. Materials/MaterialIREmitter.h  

FEmitter & OutputsWithComponentMask ( FValueRef Value
)

 Flows given `Value_ out of all outputs in the current expression. Materials/MaterialIREmitter.h  
Emits the partial derivative of given value. Materials/MaterialIREmitter.h  

FValueRef Poison()

 Emits the poison value. Materials/MaterialIREmitter.h  
  Materials/MaterialIREmitter.h  

FValueRef PreshaderParameter ( FType Type,
EPreshader2Opcode Opcode,
FValueRef SourceParameter,
FPreshaderParameterPayload Payload
)

 Emits a preshader parameter value with given opcode. Materials/MaterialIREmitter.h  
Emits an instruction that sets the material attribute with given property to given argument. Materials/MaterialIREmitter.h  

FValueRef Reciprocal ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Round ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Rsqrt ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Saturate ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Select ( FValueRef A,
FValueRef B,
FValueRef C
)

   Materials/MaterialIREmitter.h  

void SetCustomOutputs ( FStringView Name,
TConstArrayView< FValueRef > Args,
EMaterialOutputFrequency Frequency
)

 Emits a group of custom outputs. Materials/MaterialIREmitter.h  

void SetCustomOutputs ( FStringView Name,
TConstArrayView< FValueRef > Args,
EMaterialOutputFrequency Frequency,
TFunctionRef< void(FMaterialIRModule&)> Func
)

   Materials/MaterialIREmitter.h  

FValueRef Sign ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Sin ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Sinh ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef Smoothstep ( FValueRef A,
FValueRef B,
FValueRef C
)

   Materials/MaterialIREmitter.h  

FValueRef Sqrt ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef StageSwitch ( FType Type,
TConstArrayView< FValueRef > ValuePerStage
)

 Emits a stage switch instruction. Materials/MaterialIREmitter.h  

FValueRef Step ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  

void Subgraph ( int32 NumInputs,
TArrayView< FSubgraphOutputMapping > Outputs
)

 Registers the current expression as a subgraph. Materials/MaterialIREmitter.h  

FValueRef SubgraphInput ( int32 InputIndex
)

 Retrieves the value from the subgraph expression's input pin at the given index. Materials/MaterialIREmitter.h  

FValueRef Subscript ( FValueRef Value,
int32 Index
)

 Extracts the component with given index from the given argument value. Materials/MaterialIREmitter.h  

FValueRef SubstrateAdd ( FValueRef A,
FValueRef B,
FValueRef OperatorIndex,
FValueRef MaxDistanceFromLeaves
)

 Get the SubstrateData resulting from the addition of the A abd B slabs. Materials/MaterialIREmitter.h  

FValueRef SubstrateAddParameterBlending ( FValueRef A,
FValueRef B,
FValueRef NormalMix,
FValueRef SharedLocalBasisIndexMacro,
FValueRef ANoV,
FValueRef BNoV
)

 Parameter blended version of SubstrateAdd. Materials/MaterialIREmitter.h  

FValueRef SubstrateCoverageWeight ( FValueRef A,
FValueRef Weight,
FValueRef OperatorIndex,
FValueRef MaxDistanceFromLeaves
)

 Get the SubstrateData resulting from the coverage weight of the A by Weight. Materials/MaterialIREmitter.h  

FValueRef SubstrateCoverageWeightParameterBlending ( FValueRef A,
FValueRef Weight
)

 Parameter blended version of SubstrateCoverageWeight. Materials/MaterialIREmitter.h  

FValueRef SubstrateDefaultSlab()

 Emits an instruction that promotes a SubstrateData representing a default slab, encoded as MCT_Substrate. Materials/MaterialIREmitter.h  

FValueRef SubstrateHorizontalMixing ( FValueRef Background,
FValueRef Foreground,
FValueRef Mix,
FValueRef OperatorIndex,
FValueRef MaxDistanceFromLeaves
)

 Get the SubstrateData resulting from the horizontal mixing of the Background and Foreground SubstrateData. Materials/MaterialIREmitter.h  

FValueRef SubstrateHorizontalMixingParameterBlending ( FValueRef Background,
FValueRef Foreground,
FValueRef Mix,
FValueRef NormalMix,
FValueRef SharedLocalBasisIndexMacro,
FValueRef BackgroundNoV,
FValueRef ForegroundNoV
)

 Parameter blended version of SubstrateHorizontalMixing. Materials/MaterialIREmitter.h  

FValueRef SubstratePromoteToOperator ( FValueRef SubstrateData,
FValueRef OperatorIndex,
FValueRef BSDFIndex,
FValueRef LayerDepth,
FValueRef bIsBottom
)

 Promote a SubstrateData BSDF to an operator so that is becomes a node of the SubstrateTree and can be combined with other operators. Materials/MaterialIREmitter.h  

FValueRef SubstrateSelectParameterBlending ( FValueRef A,
FValueRef B,
FValueRef SelectValueArg,
FValueRef SharedLocalBasisIndexMacro
)

 Parameter blended version of SubstrateSelect, selecting and thus enforcing a single BSDF per pixel: A and B. Materials/MaterialIREmitter.h  

FValueRef SubstrateShadingModels ( const FSubstrateShadingModelsDesc Desc
)

 Create a SubstrateData representing a legacy BSDF. Materials/MaterialIREmitter.h  

FValueRef SubstrateSlab ( const FSubstrateSlabDesc& Desc
)

 Create a SubstrateData representing a Slab BSDF. Materials/MaterialIREmitter.h  

FValueRef SubstrateToon ( const FSubstrateToonDesc& Desc
)

 Create a SubstrateData representing a Toon BSDF. Materials/MaterialIREmitter.h  

FValueRef SubstrateVerticalLayering ( FValueRef Top,
FValueRef Base,
FValueRef OperatorIndex,
FValueRef MaxDistanceFromLeaves
)

 Get the SubstrateData resulting from the vertical layering of the Top over the Base SubstrateData. Materials/MaterialIREmitter.h  

FValueRef SubstrateVerticalLayeringParameterBlending ( FValueRef Top,
FValueRef Base,
FValueRef SharedLocalBasisIndexMacro,
FValueRef TopNoV,
FValueRef BaseNoV
)

 Parameter blended version of SubstrateVerticalLayering. Materials/MaterialIREmitter.h  

FValueRef Subtract ( FValueRef A,
FValueRef B
)

   Materials/MaterialIREmitter.h  
Swizzles the given argument by given mask. Materials/MaterialIREmitter.h  

FValueRef Tan ( FValueRef A
)

   Materials/MaterialIREmitter.h  

FValueRef TextureGather ( FValueRef Texture,
FValueRef TexCoord,
ETextureReadMode GatherMode,
const FTextureSampleAttributes& BaseAttributes
)

 Emits a texture gather instruction. Materials/MaterialIREmitter.h  

FValueRef TextureSample ( FValueRef Texture,
FValueRef TexCoord,
bool bAddViewMaterialMipBias,
const FTextureSampleAttributes& BaseAttributes
)

 Emits a texture sample instruction. Materials/MaterialIREmitter.h  

FValueRef TextureSampleBias ( FValueRef Texture,
FValueRef TexCoord,
FValueRef MipBias,
bool bAddViewMaterialMipBias,
const FTextureSampleAttributes& BaseAttributes
)

 Emits a texture sample instruction with bias added to the automatically selected mip level. Materials/MaterialIREmitter.h  

FValueRef TextureSampleGrad ( FValueRef Texture,
FValueRef TexCoord,
FValueRef TexCoordDdx,
FValueRef TexCoordDdy,
bool bAddViewMaterialMipBias,
const FTextureSampleAttributes& BaseAttributes
)

 Emits a texture sample instruction using user provided partial derivatives. Materials/MaterialIREmitter.h  

FValueRef TextureSampleLevel ( FValueRef Texture,
FValueRef TexCoord,
FValueRef MipLevel,
bool bAddViewMaterialMipBias,
const FTextureSampleAttributes& BaseAttributes
)

 Emits a texture sample instruction with a manually given mip level. Materials/MaterialIREmitter.h  

FValueRef TextureUniform ( FName Name,
UTexture* Texture,
EMaterialSamplerType SamplerType
)

 Emits a texture uniform value of any type except for runtime virtual textures. Materials/MaterialIREmitter.h  

bool ToConstantBool ( FValueRef Value
)

 Casts the value flowing into this input to a constant boolean and returns it. Materials/MaterialIREmitter.h  
Transposes the given MxN primitive value into the NxM result. Materials/MaterialIREmitter.h  

FValueRef Truncate ( FValueRef A
)

   Materials/MaterialIREmitter.h  
Tries to find a common type between A and B. Materials/MaterialIREmitter.h  
Retrieves the value from the given input, if present. Materials/MaterialIREmitter.h  

FValueRef TrySubgraphInput ( int32 InputIndex
)

 Retrieves the value from the subgraph expression's input pin at the given index, if present. Materials/MaterialIREmitter.h  
Emits a vector putting together all the components of given arguments. Materials/MaterialIREmitter.h  

FValueRef Vector2 ( FValueRef X,
FValueRef Y
)

 Emits a 2D column vector from X and Y scalars. Materials/MaterialIREmitter.h  
Emits a 3D column vector concatenating A, B and C components. Materials/MaterialIREmitter.h  
Emits a 4D column vector concatenating A, B, C and D components. Materials/MaterialIREmitter.h  
Creates a vertex to pixel interpolator for the given value. Materials/MaterialIREmitter.h  

FValueRef VirtualTextureUniform ( FName Name,
URuntimeVirtualTexture* VirtualTexture,
int32 VTLayerIndex,
int32 VTPageTableIndex
)

 Emits a runtime virtual texture uniform value. Materials/MaterialIREmitter.h  

FValueRef VTPageTableLoad ( FValueRef Texture,
TextureAddress AddressU,
TextureAddress AddressV,
FValueRef TexCoord,
FValueRef TexCoordDdx,
FValueRef TexCoordDdy,
bool bEnableFeedback,
bool bIsAdaptive,
ETextureMipValueMode MipValueMode,
FValueRef MipValue
)

 TODO. Materials/MaterialIREmitter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page