1. Epic GamesDeveloper
  3. HLSLTree

HLSLTree

API > API/Runtime > API/Runtime/Engine

Classes

  Type Name Description
Public struct FConnectionKey Used to associate owner objects (such as UMaterialExpression) with the FExpressions used to generate their input This is currently only used to color pins/wires based on types in the material editor  
Public struct FCustomHLSLInput    
Public class FEmitContext Tracks shared state while emitting HLSL code  
Public class FEmitCustomHLSL    
Public struct FEmitCustomHLSLInput    
Public struct FEmitCustomHLSLParameterResult    
Public struct FEmitOwnerScope    
Public struct FEmitPreshaderScope    
Public class FEmitScope FEmitScopes mostly track FScopes, except they hold transient state used while emitting HLSL The exception is FFunction, which allows FScopes to be dynamically injected into the hierarchy, which will result in FEmitScopes matching this dynamic hierarchy  
Public class FEmitShaderExpression Represents an HLSL expression  
Public class FEmitShaderNode    
Public struct FEmitShaderScopeEntry    
Public class FEmitShaderStatement    
Public struct FEmitValuePreshaderResult    
Public struct FEmitValueShaderResult    
Public class FErrorHandlerInterface Used to report any errors generating when preparing the HLSLTree  
Public class FExpression Represents an HLSL expression.  
Public class FExpressionAppend    
Public class FExpressionComponentMask Similar to FExpressionSwizzle, except swizzle parameters are extracted from a 'Mask' expression, which is expected to generate a 'bool4' component mask (which is then used to initialize a FSwizzleParameters) The 'Mask' input is required to be constant (otherwise an error is generated) This is used to support material StaticParameterMask expressions, in most cases FExpressionSwizzle is a better choice  
Public class FExpressionConstant    
Public class FExpressionCustomHLSL    
Public class FExpressionDefaultValue Forwards to another expression, but will fallback to the 'DefaultValue' constant if the forwarded expression fails  
Public class FExpressionDerivative    
Public struct FExpressionDerivatives    
Public class FExpressionError    
Public class FExpressionFeatureLevelSwitch    
Public class FExpressionForward Forwards all calls to the owned expression Intended to be used as a baseclass, where derived classes may hook certain method overrides  
Public class FExpressionGetStructField    
Public class FExpressionInlineCustomHLSL Can be used to emit HLSL chunks with no inputs, where it's not worth the trouble of defining a new expression type  
Public class FExpressionQualitySwitch    
Public class FExpressionSelect    
Public class FExpressionSetStructField    
Public class FExpressionShaderStageSwitch    
Public class FExpressionShadingPathSwitch    
Public class FExpressionSwitchBase    
Public class FExpressionSwizzle    
Public struct FFormatArgVariant    
Public class FFunction Functions are a way to dynamically inject new scopes into the tree They are used to represent calls to material functions using execution flow, and to inject dynamic branches without explicit control flow  
Public class FHasher    
Public class FNode Root class of the HLSL AST  
Public class FNullErrorHandler    
Public struct FOperationDescription    
Public class FOwnedNode OwnedNodes track 1 or more UObject 'owners' When generating HLSLTree for materials, the owner will typically be the UMaterialExpression that created the node, or the UMaterial itself Since certain nodes (FExpressions) are deduplicated and shared, it's possible to have multiple owners, if multiple owners attempt to create a node with the same parameters Tracking owners is important for the following reasons:  
Public struct FOwnerScope    
Public struct FPreparedComponent Prepared state for a single component.  
Public class FPreparedType Represents the prepared type of an FExpression.  
Public class FPrepareValueResult    
Public struct FPreshaderLocalPHIScope    
Public class FRequestedType FRequestedType is used when accessing various FExpression methods.  
Public class FScope Represents an HLSL scope.  
Public class FStatement Represents an HLSL statement.  
Public class FStatementBreak    
Public class FStatementError    
Public class FStatementIf    
Public class FStatementLoop    
Public struct FSwizzleParameters    
Public struct FTargetParameters    
Public class FTree The HLSL AST. Basically a wrapper around the root scope, with some helper methods  

Constants

Name Description
UE::HLSLTree::MaxNumPreviousScopes  

Typedefs

Name Description
FEmitShaderDependencies  
FEmitShaderScopeStack  
FFormatArgList  

Enums

  Type Name Description
Public enum UE::HLSLTree::EDerivativeCoordinate Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::HLSLTree::EEmitCastFlags Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::HLSLTree::EEmitScopeFormat Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::HLSLTree::EEmitScopeState Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::HLSLTree::EExpressionEvaluation Describes how a given expression needs to be evaluated  
Public enum UE::HLSLTree::EFormatArgType Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::HLSLTree::EOperation Copyright Epic Games, Inc. All Rights Reserved.  

Functions

  Type Name Description
Public function void

UE::HLSLTree::AppendHash ( FHasher& Hasher,
const TBitArray< Allocator >& Value
)

  
Public function void

UE::HLSLTree::AppendHash ( FHasher& Hasher,
const Shader::FValue& Value
)

  
Public function void  
Public function void  
Public function void

UE::HLSLTree::AppendHash ( FHasher& Hasher,
const TCHAR* Value
)

  
Public function void

UE::HLSLTree::AppendHash ( FHasher& Hasher,
const FString& Value
)

  
Public function void

UE::HLSLTree::AppendHash ( FHasher& Hasher,
FStringView Value
)

  
Public function void

UE::HLSLTree::AppendHash ( FHasher& Hasher,
const FName& Value
)

  
Public function void

UE::HLSLTree::AppendHash ( FHasher& Hasher,
TArrayView< T > Value
)

  
Public function void

UE::HLSLTree::AppendHash ( FHasher& Hasher,
const T& Value
)

  
Public function void

UE::HLSLTree::AppendHash ( FHasher& Hasher,
const FRequestedType& Value
)

  
Public function void

UE::HLSLTree::AppendHashes ( FHasher& Hasher,
const T& Value,
ArgTypes&&... Args
)

  
Public function void  
Public function void

UE::HLSLTree::FormatString ( FStringBuilderBase& OutString,
FEmitShaderDependencies& OutDependencies,
const FormatType& Format,
Types... Args
)

 FormatString() provides printf-like functionality, except dependencies are automatically extracted from the list of Args In addition, a single '' is used for all format specifiers, since the Args list is strongly typed Not all printf arg types are currently supported, but more can be added by extending FFormatArgVariant to support more types
Public function void

UE::HLSLTree::FormatStrings ( FStringBuilderBase& OutString0,
FStringBuilderBase& OutString1,
FEmitShaderDependencies& OutDependencies,
const FormatType0& Format0,
const FormatType1& Format1,
Types... Args
)

  
Public function uint32  
Public function FXxHash64

UE::HLSLTree::HashValue ( const T& Value
)

  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function constexpr bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function constexpr EEmitCastFlags  
Public function EEmitCastFlags &  
Public function constexpr EEmitCastFlags  
Public function EEmitCastFlags &  
Public function constexpr EEmitCastFlags  
Public function EEmitCastFlags &  
Public function constexpr EEmitCastFlags  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function void  
Public function void

UE::HLSLTree::Private::BuildFormatArgList ( FFormatArgList& OutList,
Type Arg,
Types... Args
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page