1. Epic GamesDeveloper
  3. FShaderCompilerInput

FShaderCompilerInput

Struct that gathers all readonly inputs needed for the compilation of a single shader.

Unreal Engine C++ API Reference > Runtime > RenderCore

References

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

Syntax

struct FShaderCompilerInput

Remarks

Struct that gathers all readonly inputs needed for the compilation of a single shader.

Variables

  Type Name Description
Public variable bool bCachePreprocessed True if the cache key for this job should be based on preprocessed source.
Public variable bool bCompilingForShaderPipeline Shader pipeline information.
Public variable bool bIncludeUsedOutputs  
Public variable bool bIndependentPreprocessed True if the backend for this job implements the independent preprocessing API.
Public variable bool bSkipPreprocessedCache Skips the preprocessor and instead loads the usf file directly.
Public variable FName CompressionFormat  
Public variable FString DebugDescription Description of the configuration used when compiling.
Public variable FString DebugExtension  
Public variable FString DebugGroupName Materialname or "Global" "for debugging and better error messages
Public variable EShaderDebugInfoFlags DebugInfoFlags Indicates which additional debug outputs should be written for this compile job.
Public variable FString DumpDebugInfoPath Only used if enabled by r.DumpShaderDebugInfo (platform/groupname) e.g. ""
Public variable FString DumpDebugInfoRootPath Dump debug path (up to platform) e.g. "D:/Project/Saved/ShaderDebugInfo/PCD3D_SM5".
Public variable FString EntryPointName  
Public variable FShaderCompilerEnvironment Environment Compilation Environment.
Public variable FExtraShaderCompilerSettings ExtraSettings Additional compilation settings that can be filled by FMaterial::SetupExtraCompilationSettingsFMaterial::SetupExtraCompilationSettings is usually called by each (*)MaterialShaderType::BeginCompileShader() function
Public variable FBlake3Hash Hash Hash of this input (used as the key for the shader job cache)
Public variable FOodleDataCompression::ECompressor OodleCompressor Oodle-specific compression algorithm - used if CompressionFormat is set to NAME_Oodle.
Public variable FOodleDataCompression::ECompressionLevel OodleLevel Oodle-specific compression level - used if CompressionFormat is set to NAME_Oodle.
Public variable const FShaderParametersMetadata * RootParametersStructure The root of the shader parameter structures / uniform buffers bound to this shader to generate shader resource table from.
Public variable FName ShaderFormat  
Public variable FString ShaderName  
Public variable FName ShaderPlatformName  
Public variable TRefCountPtr< FSharedShaderCompilerEnvironment > SharedEnvironment  
Public variable FShaderTarget Target  
Public variable TArray< FString > UsedOutputs  
Public variable FString VirtualSourceFilePath  

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 bGenerateDirectCompileFile field.
Public function    

Functions

  Type Name Description
Public function void

DeserializeSharedInputs ( FArchive& Ar,
const TMap< FString, FThreadSafeSharedStringPtr >& ExternalIncludes,
const TArray< FShaderCompilerEnvironment >& SharedEnvironments,
const TArray< TUniquePtr< FShaderParametersMetadata >>& ShaderParameterStructures
)

  
Public function Const bool  
Public function void

GatherSharedInputs ( TMap< FString, FString >& ExternalIncludes,
TArray< TRefCountPtr< FSharedShaderCompilerEnvironment >>& SharedEnvironments,
TArray< const FShaderParametersMetadata* >& ParametersStructures
)

  
Public function Const FString Generate human readable name for debugging
Public function Const FString  
Public function Const FStringView  
Public function Const bool  
Public function void

SerializeSharedInputs ( FArchive& Ar,
const TArray< TRefCountPtr< FSharedShaderCompilerEnvironment >>& SharedEnvironments,
const TArray< const FShaderParametersMetadata* >& ParametersStructures
)

  
Public function Const bool  

Operators

  Type Name Description
Public function FShaderCompilerInput &  
Public function FShaderCompilerInput &  

Deprecated Variables

  Type Name Description
Public variable bool bGenerateDirectCompileFile Use DebugInfoFlags field (EDebugInfoFlags::DirectCompileCommandLine)

Deprecated Functions

  Type Name Description
Public function Const bool CanCompileWithLegacyFxc doesn't have enough information to correctly flag the input as requiring FXC. Please use internal shader format code instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page