1. Epic GamesDeveloper
  3. ShaderCompilerCommon

ShaderCompilerCommon

Unreal Engine C++ API Reference > Developer

Classes

  Type Name Description
Public class FBaseShaderFormat    
Public struct FDebugShaderDataOptions    
Public struct FDiagnosticMessage    
Public struct FDiagnostics    
Public struct FDllHandle    
Public class FDxcModuleWrapper    
Public struct FHlslccHeader    
Public class FHlslccHeaderWriter    
Public struct FHlslShaderModel Shader model version for HLSL input language.  
Public struct FMinifiedShader    
Public class FShaderConductorContext Wrapper class to handle interface between UE and ShaderConductor.  
Public struct FShaderConductorIdentifierTable Container for all special case SPIR-V identifiers generated by ShaderConductor.  
Public class FShaderConductorModuleWrapper    
Public struct FShaderConductorOptions Wrapper structure to pass options descriptor to ShaderConductor.  
Public struct FShaderConductorTarget Shader conductor output target descriptor.  
Public struct FSpirv Base structure for SPIR-V modules in the shader backends.  
Public struct FSpirvReflectBindings Container structure for all SPIR-V reflection resources and in/out attributes.  
Public class TSpirvForwardIterator Template forward iterator for SPIR-V instructions.  

Constants

Name Description
UE::ShaderCompilerCommon::kBindlessResourcePrefix  
UE::ShaderCompilerCommon::kBindlessSamplerPrefix  
UE::ShaderCompilerCommon::kUniformBufferConstantBufferPrefix  

Typedefs

Name Description
FSpirvConstIterator  
FSpirvIterator  

Enums

  Type Name Description
Public enum CrossCompiler::EShaderConductorIR Intermediate representation languages for ShaderConductor disassembly output.  
Public enum CrossCompiler::EShaderConductorLanguage Target high level languages for ShaderConductor output.  
Public enum EShaderConductorTarget    
Public enum UE::ShaderMinifier::EMinifyShaderFlags    

Functions

  Type Name Description
Public function void Adds a note to CompilerOutput.Error about where the shader parameter structure is on C++ side.
Public function void

AddUnboundShaderParameterError ( const FShaderCompilerInput& CompilerInput,
const FShaderParameterParser& ShaderParameterParser,
const FString& ParameterBindingName,
FShaderCompilerOutput& CompilerOutput
)

 Adds an error to CompilerOutput.Error about a shader parameters that could not be bound.
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGSbool

BuildResourceTableMapping ( const TMap< FString, FResourceTableEntry >& ResourceTableMap,
const TMap< FString, FUniformBufferEntry >& UniformBufferMap,
TBitArray<>& UsedUniformBufferSlots,
FShaderParameterMap& ParameterMap,
FShaderCompilerResourceTable& OutSRT
)

 No longer supported; use version of function that accepts a FShaderResourceTableMap instead
Public function bool

BuildResourceTableMapping ( const FShaderResourceTableMap& ResourceTableMap,
const TMap< FString, FUniformBufferEntry >& UniformBufferMap,
TBitArray<>& UsedUniformBufferSlots,
FShaderParameterMap& ParameterMap,
FShaderCompilerResourceTable& OutSRT
)

 This function looks for resources specified in ResourceTableMap in the parameter map, adds them to the resource table, and removes them from the parameter map.
Public function void

BuildResourceTableTokenStream ( const TArray< uint32 >& InResourceMap,
int32 MaxBoundResourceTable,
TArray< uint32 >& OutTokenStream,
bool bGenerateEmptyTokenStreamIfNoResources
)

 Builds a token stream out of the resource map.
Public function void

CompileOfflineMali ( const FShaderCompilerInput& Input,
FShaderCompilerOutput& ShaderOutput,
const ANSICHAR* ShaderSource,
const int32 SourceSize,
bool bVulkanSpirV,
const ANSICHAR* VulkanSpirVEntryPoint
)

 Calls 'Mali Offline Compiler' to compile the glsl source code and extract the generated instruction count
Public function bool

ConvertFromFP32ToFP16 ( FString& InOutSourceCode,
TArray< FString >& OutErrors
)

  
Public function bool

CrossCompiler::Match ( const TCHAR*& Str,
const TCHAR* Sub
)

  
Public function bool

CrossCompiler::Match ( const ANSICHAR*& Str,
const ANSICHAR* Sub
)

  
Public function bool

CrossCompiler::Match ( const TCHAR*& Str,
ANSICHAR Char
)

  
Public function bool

CrossCompiler::Match ( const ANSICHAR*& Str,
ANSICHAR Char
)

  
Public function bool

CrossCompiler::ParseIdentifier ( const ANSICHAR*& Str,
FString& OutStr
)

  
Public function bool

CrossCompiler::ParseIdentifier ( const TCHAR*& Str,
FString& OutStr
)

  
Public function bool

CrossCompiler::ParseIntegerNumber ( const ANSICHAR*& Str,
T& OutNum
)

  
Public function bool

CrossCompiler::ParseIntegerNumber ( const TCHAR*& Str,
T& OutNum
)

  
Public function bool

CrossCompiler::ParseSignedNumber ( const TCHAR*& Str,
int32& OutNum
)

  
Public function bool

CrossCompiler::ParseSignedNumber ( const ANSICHAR*& Str,
int32& OutNum
)

  
Public function bool

CrossCompiler::ParseString ( const TCHAR*& Str,
FString& OutStr
)

  
Public function bool

CrossCompiler::ParseString ( const ANSICHAR*& Str,
FString& OutStr
)

  
Public function void

CullGlobalUniformBuffers ( const TMap< FString, FUniformBufferEntry >& UniformBufferMap,
FShaderParameterMap& ParameterMap
)

 Culls global uniform buffer entries from the parameter map.
Public function Static void

DumpDebugBlobDetail ( IDxcBlob* Blob,
const TCHAR* BlobName
)

  
Public function void

DumpDebugShaderBinary ( const FShaderCompilerInput& Input,
void* InData,
int32 InDataByteSize,
const FString& FileName,
const FString& FileExtension
)

  
Public function void

DumpDebugShaderBinary ( const FShaderCompilerInput& Input,
void* InData,
int32 InDataByteSize,
const FString& FileExtension
)

  
Public function void

DumpDebugShaderDisassembledDxil ( const FShaderCompilerInput& Input,
void* InData,
int32 InDataByteSize,
const FString& FileExtension
)

  
Public function void

DumpDebugShaderDisassembledSpirv ( const FShaderCompilerInput& Input,
void* InData,
int32 InDataByteSize,
const FString& FileExtension
)

  
Public function void

DumpDebugShaderText ( const FShaderCompilerInput& Input,
const FString& InSource,
const FString& FileExtension
)

  
Public function void

DumpDebugShaderText ( const FShaderCompilerInput& Input,
ANSICHAR* InSource,
int32 InSourceLength,
const FString& FileExtension
)

  
Public function void

DumpDebugShaderText ( const FShaderCompilerInput& Input,
ANSICHAR* InSource,
int32 InSourceLength,
const FString& FileName,
const FString& FileExtension
)

  
Public function void

FindOffsetToSpirvEntryPoint ( const FSpirv& Spirv,
const ANSICHAR* EntryPointName,
uint32& OutWordOffsetToEntryPoint,
uint32& OutWordOffsetToMainName
)

 Returns word offset to the entry point (OpEntryPoint) and name of the entry point (OpName).
Public function int16 Finds the number of used uniform buffers in a resource map.
Public function void

HandleReflectedGlobalConstantBufferMember ( const FString& MemberName,
uint32 ConstantBufferIndex,
int32 ReflectionOffset,
int32 ReflectionSize,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedRootConstantBuffer ( int32 ConstantBufferSize,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedRootConstantBufferMember ( const FShaderCompilerInput& Input,
const FShaderParameterParser& ShaderParameterParser,
const FString& MemberName,
int32 ReflectionOffset,
int32 ReflectionSize,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedShaderResource ( const FString& ResourceName,
int32 ReflectionSlot,
int32 BindCount,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedShaderResource ( const FString& ResourceName,
int32 ReflectionSlot,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedShaderResource ( const FString& ResourceName,
int32 BindOffset,
int32 ReflectionSlot,
int32 BindCount,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedShaderSampler ( const FString& SamplerName,
int32 ReflectionSlot,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedShaderSampler ( const FString& SamplerName,
int32 BindOffset,
int32 ReflectionSlot,
int32 BindCount,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedShaderSampler ( const FString& SamplerName,
int32 ReflectionSlot,
int32 BindCount,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedShaderUAV ( const FString& UAVName,
int32 BindOffset,
int32 ReflectionSlot,
int32 BindCount,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedShaderUAV ( const FString& UAVName,
int32 ReflectionSlot,
int32 BindCount,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedShaderUAV ( const FString& UAVName,
int32 ReflectionSlot,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedUniformBuffer ( const FString& UniformBufferName,
int32 ReflectionSlot,
int32 BaseIndex,
int32 BufferSize,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedUniformBuffer ( const FString& UniformBufferName,
int32 ReflectionSlot,
int32 BufferSize,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedUniformBuffer ( const FString& UniformBufferName,
int32 ReflectionSlot,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void

HandleReflectedUniformBufferConstantBufferMember ( int32 UniformBufferSlot,
const FString& MemberName,
int32 ReflectionOffset,
int32 ReflectionSize,
FShaderCompilerOutput& CompilerOutput
)

  
Public function const ANSICHAR *

PatchSpirvEntryPointWithCRC ( FSpirv& Spirv,
uint32& OutCRC
)

 Renames the fixed-size entry point name (which must be "main_00000000_00000000") to the formatted name including a CRC over the module.
Public function void

RemoveUniformBuffersFromSource ( const FShaderCompilerEnvironment& Environment,
FString& PreprocessedShaderSource
)

 The cross compiler doesn't yet support struct initializers needed to construct static structs for uniform buffers Replace all uniform buffer struct member references (View.WorldToClip) with a flattened name that removes the struct dependency (View_WorldToClip)
Public function bool

RemoveUnusedInputs ( FString& InOutSourceCode,
const TArray< FString >& InUsedInputs,
FString& InOutEntryPoint,
TArray< FString >& OutErrors
)

  
Public function bool

RemoveUnusedOutputs ( FString& InOutSourceCode,
const TArray< FString >& InUsedOutputs,
const TArray< FString >& InExceptions,
FString& InOutEntryPoint,
TArray< FString >& OutErrors
)

  
Public function void

TransformStringIntoCharacterArray ( FString& PreprocessedShaderSource
)

 Processes TEXT macros.
Public function EShaderParameterType Deprecated; use FShaderParameterParser::ParseAndRemoveBindlessParameterPrefix instead
Public function EShaderParameterType Deprecated; use FShaderParameterParser::ParseAndRemoveBindlessParameterPrexix instead
Public function EShaderParameterType

UE::ShaderCompilerCommon::ParseParameterType ( FStringView InType,
TArrayView< const TCHAR*const > InExtraSRVTypes,
TArrayView< const TCHAR*const > InExtraUAVTypes
)

 Deprecated; use FShaderParameterParser::ParseParameterType instead
Public function void

UE::ShaderCompilerCommon::ParseRayTracingEntryPoint ( const FString& Input,
FString& OutMain,
FString& OutAnyHit,
FString& OutIntersection
)

 Parses ray tracing shader entry point specification string in one of the following formats: 1) Verbatim single entry point name, e.g. "MainRGS" 2) Complex entry point for ray tracing hit group shaders: a) "closesthit=MainCHS" b) "closesthit=MainCHS anyhit=MainAHS" c) "closesthit=MainCHS anyhit=MainAHS intersection=MainIS" d) "closesthit=MainCHS intersection=MainIS" NOTE: closesthit attribute must always be provided for complex hit group entry points
Public function bool Deprecated; use FShaderParameterParser::RemoveBindlessParameterPrefix instead
Public function FStringView  
Public function FString  
Public function bool

UE::ShaderCompilerCommon::RemoveDeadCode ( FString& InOutPreprocessedShaderSource,
TConstArrayView< FStringView > RequiredSymbols,
TArray< FShaderCompilerError >& OutErrors
)

 Rewrites a fully preprocessed shader source code, removing any functions or structs that are not reachable from a given entry point or list of symbols.
Public function bool

UE::ShaderCompilerCommon::RemoveDeadCode ( FString& InOutPreprocessedShaderSource,
const FString& EntryPoint,
TArray< FShaderCompilerError >& OutErrors
)

 Rewrites a fully preprocessed shader source code, removing any functions or structs that are not reachable from a given entry point or list of symbols.
Public function bool Deprecated; use FShaderCompilerInput::ShouldUseStableContantBuffer directly
Public function bool  
Public function constexpr bool  
Public function constexpr EMinifyShaderFlags  
Public function EMinifyShaderFlags &  
Public function constexpr EMinifyShaderFlags  
Public function EMinifyShaderFlags &  
Public function constexpr EMinifyShaderFlags  
Public function EMinifyShaderFlags &  
Public function constexpr EMinifyShaderFlags  
Public function void

UpdateStructuredBufferStride ( const FShaderCompilerInput& Input,
const FString& ResourceName,
uint16 BindPoint,
uint16 Stride,
FShaderCompilerOutput& CompilerOutput
)

  
Public function void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page