1. Epic GamesDeveloper
  3. FShaderCompilerOutput

FShaderCompilerOutput

The output of the shader compiler.

API > API/Runtime > API/Runtime/RenderCore

References

   
Module RenderCore
Header /Engine/Source/Runtime/RenderCore/Public/ShaderCompilerCore.h
Include #include "ShaderCompilerCore.h"

Syntax

struct FShaderCompilerOutput

Remarks

The output of the shader compiler. Bump UE_SHADER_CACHE_VERSION and ShaderCompileWorkerOutputVersion if FShaderCompilerOutput changes

Variables

  Type Name Description
Public variable bool bSerializeModifiedSource  
Public variable bool bSerializingForCache  
Public variable bool bSucceeded  
Public variable bool bSupportsQueryingUsedAttributes  
Public variable double CompileTime  
Public variable TArray< FShaderCompilerError > Errors  
Public variable FString ModifiedEntryPointName Use this field to store the entry point name if it's modified as part of the shader format's compilation process.
Public variable FString ModifiedShaderSource Use this field to store the shader source code if it's modified as part of the shader format's compilation process.
Public variable uint32 NumInstructions  
Public variable uint32 NumTextureSamplers  
Public variable FString OptionalFinalShaderSource  
Public variable FSHAHash OutputHash  
Public variable FShaderParameterMap ParameterMap  
Public variable TArray< FShaderCodeValidationType > ParametersSRVTypeToValidate  
Public variable PRAGMA_ENABLE_DEPRECATION_WARNINGSTArray< FShaderCodeValidationStride > ParametersStrideToValidate  
Public variable TArray< FShaderCodeValidationType > ParametersUAVTypeToValidate  
Public variable TArray< FShaderCodeValidationUBSize > ParametersUBSizeToValidate  
Public variable TArray< uint8 > PlatformDebugData  
Public variable TArray< FString > PragmaDirectives  
Public variable double PreprocessTime  
Public variable FShaderCode ShaderCode  
Public variable TArray< FShaderDiagnosticData > ShaderDiagnosticDatas  
Public variable TArray< FGenericShaderStat > ShaderStatistics  
Public variable FShaderTarget Target  
Public variable TArray< FString > UsedAttributes  
Public variable FShaderCompilerInputHash ValidateInputHash  

Constructors

  Type Name Description
Public function    
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS Explicitly-defaulted copy/move ctors & assignment operators are needed temporarily due to deprecation of OptionalFinalShaderSource and PragmaDirectives fields.
Public function    

Functions

  Type Name Description
Public function void

AddStatistic ( const TCHAR* Name,
TValue Value,
FGenericShaderStat::EFlags Flags
)

  
Public function void

CompressOutput ( FName ShaderCompressionFormat,
FOodleDataCompression::ECompressor OodleCompressor,
FOodleDataCompression::ECompressionLevel OodleLevel
)

 Calls GenerateOutputHash() before the compression, replaces FShaderCode with the compressed data (if compression result was smaller).
Public function void Generates OutputHash from the compiler output.
Public function Const const FShaderCodeResource &  
Public function void Add optional data in ShaderCode to perform additional shader input validation at runtime
Public function void Add optional diagnostic data in ShaderCode to perform assert translation at runtime
Public function void  

Operators

  Type Name Description
Public function FShaderCompilerOutput &  
Public function FShaderCompilerOutput &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page