1. Epic GamesDeveloper
  3. FEmitContext

FEmitContext

Tracks shared state while emitting HLSL code

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/HLSLTree

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/HLSLTree/HLSLTreeEmit.h
Include #include "HLSLTree/HLSLTreeEmit.h"

Syntax

class FEmitContext

Remarks

Tracks shared state while emitting HLSL code

Variables

  Type Name Description
Public variable FActiveStructFieldStack ActiveStructFieldStack  
Public variable FMemStackBase * Allocator  
Public variable bool bCompiledShadingModels  
Public variable bool bMarkLiveValues  
Public variable bool bUseAnalyticDerivatives  
Public variable bool bUsesSkyAtmosphere  
Public variable bool bUsesSpeedTree  
Public variable bool bUsesSphericalParticleOpacity  
Public variable bool bUsesWorldPositionExcludingShaderOffsets  
Public variable TMap< FConnectionKey, Shader::FType > ConnectionMap  
Public variable uint32 CurrentBoolUniformOffset  
Public variable uint32 CurrentNumBoolComponents  
Public variable TMap< FXxHash64, FCustomDataWrapper * > CustomDataMap  
Public variable uint32 DynamicParticleParameterMask  
Public variable TMap< FXxHash64, FEmitCustomHLSL > EmitCustomHLSLMap  
Public variable TMap< FXxHash64, FEmitShaderExpression * > EmitExpressionMap  
Public variable TMap< const FFunction *, FEmitShaderNode * > EmitFunctionMap  
Public variable TMap< FXxHash64, FEmitShaderExpression * > EmitLocalPHIMap  
Public variable TArray< FEmitShaderNode * > EmitNodes  
Public variable TMap< FXxHash64, FEmitShaderExpression * > EmitPreshaderMap  
Public variable TMap< const FScope *, FEmitScope * > EmitScopeMap  
Public variable TMap< FXxHash64, FEmitShaderExpression * > EmitValueMap  
Public variable FErrorHandlerInterface * Errors  
Public variable const FMaterial * Material TODO - Material values required for preshaders, need to decouple preshaders from material system Current plan is to implement support for externally registered preshader opcodes, and move the preshader opcodes related to material parameters into a separate module.
Public variable FMaterialCompilationOutput * MaterialCompilationOutput  
Public variable const UMaterialInterface * MaterialInterface  
Public variable int32 NumErrors  
Public variable int32 NumExpressionLocalPHIs  
Public variable int32 NumExpressionLocals  
Public variable TArray< const FOwnedNode *, TInlineAllocator< 32 > > OwnerStack  
Public variable TMap< const FExpression *, FEmitScope * > PrepareLocalPHIMap  
Public variable TMap< FXxHash64, FPrepareValueResult * > PrepareValueMap  
Public variable TArray< const FPreshaderLocalPHIScope * > PreshaderLocalPHIScopes  
Public variable TArray< struct FPreshaderLoopScope * > PreshaderLoopScopes  
Public variable int32 PreshaderStackPosition  
Public variable TMap< FXxHash64, FRequestedType * > RequestedTypeTracker  
Public variable TMap< FMaterialParameterInfo, FMaterialParameterValue > SeenStaticParameterValues  
Public variable EShaderFrequency ShaderFrequency  
Public variable FTargetParameters TargetParameters  
Public variable const Shader::FStructTypeRegistry * TypeRegistry  
Public variable uint32 UniformPreshaderOffset  

Constructors

  Type Name Description
Public function  

FEmitContext ( FMemStackBase& InAllocator,
const FTargetParameters& InTargetParameters,
FErrorHandlerInterface& InErrors,
const Shader::FStructTypeRegistry& InTypeRegistry
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function T & Finds or creates arbitrary data that's associated with this context.
Public function FEmitScope *

AcquireEmitScope ( const FScope* Scope
)

  
Public function FEmitScope *

AcquireEmitScopeWithParent ( const FScope* Scope,
FEmitScope* EmitParentScope
)

  
Public function FEmitShaderExpression *

EmitCast ( FEmitScope& Scope,
FEmitShaderExpression* ShaderValue,
const Shader::FType& DestType,
EEmitCastFlags Flags
)

  
Public function FEmitShaderExpression *

EmitConstantZero ( FEmitScope& Scope,
const Shader::FType& Type
)

  
Public function FEmitShaderExpression *

EmitCustomHLSL ( FEmitScope& Scope,
FStringView DeclarationCode,
FStringView FunctionCode,
TConstArrayView< FCustomHLSLInput > Inputs,
const Shader::FStructType* OutputType
)

 FStringViews passed to this method are expected to reference persistent memory
Public function void  
Public function FEmitShaderExpression *

EmitExpression ( FEmitScope& Scope,
const Shader::FType& Type,
const FormatType& Format,
Types... Args
)

  
Public function FEmitShaderExpression *

EmitExpressionWithDependencies ( FEmitScope& Scope,
TArrayView< FEmitShaderNode* > Dependencies,
const Shader::FType& Type,
const FormatType& Format,
Types... Args
)

 Generate a snippit of HLSL code, strings with identical contents will be deduplicated, and their dependencies will be merged
Public function FEmitShaderExpression *

EmitExpressionWithDependency ( FEmitScope& Scope,
FEmitShaderNode* Dependency,
const Shader::FType& Type,
const FormatType& Format,
Types... Args
)

  
Public function FEmitShaderStatement *

EmitFormatStatementInternal ( FEmitScope& Scope,
TArrayView< FEmitShaderNode* > Dependencies,
EEmitScopeFormat ScopeFormat,
FEmitScope* NestedScope0,
FEmitScope* NestedScope1,
const FormatType0& Format0,
const FormatType1& Format1,
Types... Args
)

  
Public function FEmitShaderExpression *

EmitInlineExpression ( FEmitScope& Scope,
const Shader::FType& Type,
const FormatType& Format,
Types... Args
)

  
Public function FEmitShaderExpression *

EmitInlineExpressionWithDependencies ( FEmitScope& Scope,
TArrayView< FEmitShaderNode* > Dependencies,
const Shader::FType& Type,
const FormatType& Format,
Types... Args
)

  
Public function FEmitShaderExpression *

EmitInlineExpressionWithDependency ( FEmitScope& Scope,
FEmitShaderNode* Dependency,
const Shader::FType& Type,
const FormatType& Format,
Types... Args
)

  
Public function FEmitShaderStatement *

EmitNestedScope ( FEmitScope& Scope,
FScope* NestedScope,
const FormatType& Format,
Types... Args
)

  
Public function FEmitShaderStatement *

EmitNestedScopes ( FEmitScope& Scope,
FScope* NestedScope0,
FScope* NestedScope1,
const FormatType0& Format0,
const FormatType1& Format1,
Types... Args
)

  
Public function FEmitShaderStatement *

EmitNextScope ( FEmitScope& Scope,
FScope* NextScope
)

  
Public function FEmitShaderStatement *

EmitNextScopeWithDependency ( FEmitScope& Scope,
FEmitShaderNode* Dependency,
FScope* NextScope
)

  
Public function FEmitShaderExpression *

EmitPreshaderOrConstant ( FEmitScope& Scope,
const FRequestedType& RequestedType,
const Shader::FType& ResultType,
const FExpression* Expression
)

  
Public function void

EmitPreshaderScope ( FEmitScope& EmitScope,
const FRequestedType& RequestedType,
TArrayView< const FEmitPreshaderScope > PreshaderScopes,
Shader::FPreshaderData& OutPreshader
)

  
Public function void

EmitPreshaderScope ( const FScope* Scope,
const FRequestedType& RequestedType,
TArrayView< const FEmitPreshaderScope > PreshaderScopes,
Shader::FPreshaderData& OutPreshader
)

  
Public function FEmitShaderStatement *

EmitStatement ( FEmitScope& Scope,
const FormatType& Format,
Types... Args
)

  
Public function FEmitShaderStatement *

EmitStatementWithDependencies ( FEmitScope& Scope,
TArrayView< FEmitShaderNode* > Dependencies,
const FormatType& Format,
Types... Args
)

  
Public function FEmitShaderStatement *

EmitStatementWithDependency ( FEmitScope& Scope,
FEmitShaderNode* Dependency,
const FormatType& Format,
Types... Args
)

  
Public function bool

Error ( const StringType& InError
)

  
Public function bool

Errorf ( const FormatType& Format,
Types... Args
)

  
Public function void  
Public function T &  
Public function Const const T &  
Public function FEmitScope *

FindEmitScope ( const FScope* Scope
)

  
Public function Const EExpressionEvaluation

GetEvaluation ( const FExpression* Expression,
const FEmitScope& Scope,
const FRequestedType& RequestedType
)

  
Public function Const FPreparedType

GetPreparedType ( const FExpression* Expression,
const FRequestedType& RequestedType
)

  
Public function Const Shader::FType

GetResultType ( const FExpression* Expression,
const FRequestedType& RequestedType
)

  
Public function Const Shader::FType

GetTypeForPinColoring ( const FExpression* Expression
)

  
Public function FEmitShaderExpression *

InternalEmitExpression ( FEmitScope& Scope,
TArrayView< FEmitShaderNode* > Dependencies,
bool bInline,
const Shader::FType& Type,
FStringView Code
)

  
Public function FEmitScope *

InternalEmitScope ( const FScope* Scope
)

  
Public function FEmitShaderStatement *

InternalEmitStatement ( FEmitScope& Scope,
TArrayView< FEmitShaderNode* > Dependencies,
EEmitScopeFormat ScopeFormat,
FEmitScope* NestedScope0,
FEmitScope* NestedScope1,
FStringView Code0,
FStringView Code1
)

  
Public function bool

InternalError ( FStringView ErrorMessage
)

  
Public function Const FCustomDataWrapper *  
Public function FEmitScope *

InternalPrepareScope ( FScope* Scope,
FScope* ParentScope
)

  
Public function void  
Public function Static TArrayView< FEmitShaderNode * >

MakeDependencies ( T*& Dependency
)

  
Public function void

MarkInputType ( const FExpression* InExpression,
const Shader::FType& Type
)

  
Public function void

MarkScopeDead ( FEmitScope& EmitParentScope,
FScope* Scope
)

  
Public function void

MarkScopeEvaluation ( FEmitScope& EmitParentScope,
FScope* Scope,
EExpressionEvaluation Evaluation
)

  
Public function FPreparedType

PrepareExpression ( const FExpression* InExpression,
FEmitScope& Scope,
const FRequestedType& RequestedType
)

  
Public function FEmitScope *

PrepareScope ( FScope* Scope
)

  
Public function FEmitScope *

PrepareScopeWithParent ( FScope* Scope,
FScope* ParentScope
)

  
Public function void  

Classes

  Type Name Description
Public class FCustomDataWrapper    
Public class TCustomDataWrapper    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page