1. Epic GamesDeveloper
  3. ShaderCompilerCommon

ShaderCompilerCommon

API > API/Developer

   
Name ShaderCompilerCommon
Type Developer
Location /Engine/Source/Developer/ShaderCompilerCommon/
Module Build Rules ShaderCompilerCommon.Build.cs

Classes

Name Remarks
FBaseShaderFormat  
FDxcModuleWrapper  
FHlslccHeaderWriter  
FShaderConductorContext Wrapper class to handle interface between UE and ShaderConductor.
FShaderConductorModuleWrapper  
TSpirvForwardIterator Template forward iterator for SPIR-V instructions.

Structs

Name Remarks
FDebugShaderDataOptions  
FDiagnostics  
FDllHandle  
FHlslccHeader  
FHlslShaderModel Shader model version for HLSL input language.
FMinifiedShader  
FShaderConductorIdentifierTable Container for all special case SPIR-V identifiers generated by ShaderConductor.
FShaderConductorOptions Wrapper structure to pass options descriptor to ShaderConductor.
FShaderConductorTarget Shader conductor output target descriptor.
FSpirv Base structure for SPIR-V modules in the shader backends.
FSpirvReflectBindings Container structure for all SPIR-V reflection resources and in/out attributes.

Typedefs

Name Type Remarks Include Path
FSpirvConstIterator TSpirvForwardIterator< const uint32 >   SpirvCommon.h
FSpirvIterator TSpirvForwardIterator< uint32 >   SpirvCommon.h

Enums

Public

Name Remarks
CrossCompiler::EShaderConductorIR Intermediate representation languages for ShaderConductor disassembly output.
CrossCompiler::EShaderConductorLanguage Target high level languages for ShaderConductor output.
EInstructionSet  
EShaderConductorTarget  
EUniformBufferMemberReflectionReason  
UE::ShaderMinifier::EMinifyShaderFlags  

Constants

Name Type Remarks Include Path
UE::ShaderCompilerCommon::kPlatformHashStatName const TCHAR *   ShaderCompilerCommon.h
UE::ShaderCompilerCommon::kUniformBufferConstantBufferPrefix const TCHAR *   ShaderCompilerCommon.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Symbols TConstArrayView< FStringView > Structure to hold forward declarations for a specific scope/namespace chain for the HlslParser ShaderCompilerCommon.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddNoteToDisplayShaderParameterStructureOnCppSide ( const FShaderParametersMetadata* ParametersStructure,
FShaderCompilerOutput& CompilerOutput
)

 Adds a note to CompilerOutput.Error about where the shader parameter structure is on C++ side. ShaderCompilerCommon.h  

void AddShaderValidationSRVType ( uint16 BindPoint,
EShaderCodeResourceBindingType TypeDecl,
FShaderCompilerOutput& CompilerOutput
)

   ShaderCompilerCommon.h  

void AddShaderValidationUAVType ( uint16 BindPoint,
EShaderCodeResourceBindingType TypeDecl,
FShaderCompilerOutput& CompilerOutput
)

   ShaderCompilerCommon.h  

void AddShaderValidationUBSize ( uint16 BindPoint,
uint32_t Size,
FShaderCompilerOutput& CompilerOutput
)

   ShaderCompilerCommon.h  

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. ShaderCompilerCommon.h  

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. ShaderCompilerCommon.h  

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

 Builds a token stream out of the resource map. ShaderCompilerCommon.h  

void CleanupUniformBufferCode ( const FShaderCompilerEnvironment& Environment,
FShaderSource& PreprocessedShaderSource
)

 Convert generated UniformBuffer code and references into something the shader compilers can use. ShaderCompilerCommon.h  

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

 Calls 'Offline Compiler' to compile the source code and extract the stats ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

 Culls global uniform buffer entries from the parameter map. ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  
  ShaderCompilerCommon.h  
Shader input/output parameter storage classes. ShaderCompilerCommon.h  

const CharType * FindMatchingBlock ( const CharType* OpeningCharPtr,
char OpenChar,
char CloseChar
)

   ShaderCompilerCommon.h  

const CharType * FindMatchingClosingBrace ( const CharType* OpeningCharPtr
)

   ShaderCompilerCommon.h  

FStringView FindNextHLSLDefinitionOfType ( FStringView Typename,
FStringView StartPos
)

   ShaderCompilerCommon.h  

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). SpirvCommon.h  

const ANSICHAR * FindSpirvEntryPoint ( const FSpirv& Spirv
)

 Finds the entry point name name. SpirvCommon.h  

int16 GetNumUniformBuffersUsed ( const FShaderCompilerResourceTable& InSRT
)

 Finds the number of used uniform buffers in a resource map. ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

void HandleReflectedRootConstantBuffer ( int32 ConstantBufferSize,
FShaderCompilerOutput& CompilerOutput
)

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

void HandleReflectedUniformBufferConstantBufferMember ( EUniformBufferMemberReflectionReason Reason,
FStringView UniformBufferName,
int32 UniformBufferSlot,
FStringView MemberName,
int32 ReflectionOffset,
int32 ReflectionSize,
FShaderCompilerOutput& CompilerOutput
)

   ShaderCompilerCommon.h  

bool InlineFunction ( FString& InOutSourceCode,
FString& InOutEntryPoint,
const FStringView FunctionToInline,
TArray< FString >& OutErrors
)

 EXPERIMENTAL: Adds a new function to the shader where calls to FunctionToInline_ from EntryPoint_ are inlined using AST manipulation Current limitations: ShaderCompilerCommon.h  

bool ISAParser::HasDerivativeOps ( bool& bHasDerivativeOps,
const char* Code,
uint32 CodeLength,
EInstructionSet InstructionSet
)

   ISAParser/ISAParser.h  

const TCHAR * ParseHLSLSymbolName ( const TCHAR* SearchString,
FString& SymboName
)

   ShaderCompilerCommon.h  

void ParseHLSLTypeName ( const TCHAR* SearchString,
const TCHAR*& TypeNameStartPtr,
const TCHAR*& TypeNameEndPtr
)

   ShaderCompilerCommon.h  

void ParseSpirvGlobalVariables ( const FSpirv& Spirv,
SpvStorageClass StorageClass,
TArray< FString >& OutVariableNames
)

 Parse global variables (anything but function local variables) of specified storage class from the specified SPIR-V module. SpirvCommon.h  

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. SpirvCommon.h  

bool RemoveUnusedInputs ( ...
)

   ShaderCompilerCommon.h  

bool RemoveUnusedOutputs ( ...
)

   ShaderCompilerCommon.h  

EUniformBufferMemberReflectionReason ShouldReflectUniformBufferMembers ( const FShaderCompilerInput& Input,
FStringView UniformBufferName
)

   ShaderCompilerCommon.h  

const TCHAR * SpirvBuiltinToString ( const SpvBuiltIn BuiltIn
)

 Returns the string representation of the specified SPIR-V built-in variable, e.g. SpvBuiltInPosition to TEXT("gl_Position"). SpirvCommon.h  

void UE::ShaderCompilerCommon::BuildShaderResourceTable ( const FShaderCompilerResourceTable& GenericSRT,
FShaderResourceTable& OutSRT,
bool bGenerateEmptyTokenStreamIfNoResources
)

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

void UE::ShaderCompilerCommon::ParseRayTracingEntryPoint ( const FStringView& Input,
FStringView& OutMain,
FStringView& OutAnyHit,
FStringView& 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 ShaderCompilerCommon.h  

FStringView UE::ShaderCompilerCommon::RemoveConstantBufferPrefix ( FStringView InName
)

   ShaderCompilerCommon.h  

FString UE::ShaderCompilerCommon::RemoveConstantBufferPrefix ( const FString& InName
)

   ShaderCompilerCommon.h  

bool UE::ShaderCompilerCommon::RemoveDeadCode ( FShaderSource& 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. ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

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

   ShaderCompilerCommon.h  

bool UE::ShaderCompilerCommon::ValidatePackedResourceCounts ( FShaderCompilerOutput& Output,
const FShaderCodePackedResourceCounts& PackedResourceCounts
)

   ShaderCompilerCommon.h  

bool UE::ShaderCompilerCommon::ValidateShaderAgainstKnownIssues ( const FString& InSourceCode,
TArray< FString >& OutErrors,
const TCHAR* InSourceCodeFilename
)

 Runs a few validation steps and reports any known issues such as parameter names that might cause problems on certain backend compilers, especially the old FXC compiler. ShaderCompilerCommon.h  

UE::ShaderMinifier::ENUM_CLASS_FLAGS ( EMinifyShaderFlags
)

   ShaderMinifier.h  

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

   ShaderCompilerCommon.h  

void WriteShaderConductorCommandLine ( const FShaderCompilerInput& Input,
const FString& SourceFilename,
EShaderConductorTarget Target
)

   ShaderCompilerCommon.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DumpDebugBlobDetail ( IDxcBlob* Blob,
const TCHAR* BlobName
)

      

static HRESULT RetrieveDebugNameAndBlob ( TRefCountPtr< IDxcResult >& CompileResult,
FString& OutDebugBlobName,
IDxcBlob** OutDebugBlob,
DxcShaderHash& ShaderHash
)

      

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page