1. Epic GamesDeveloper
  3. IShaderFormat

IShaderFormat

[IShaderFormat](API\Developer\TargetPlatform\IShaderFormat), shader pre-compilation abstraction

API > API/Developer > API/Developer/TargetPlatform

IShaderFormat, shader pre-compilation abstraction

   
Name IShaderFormat
Type class
Header File /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h
Include Path #include "Interfaces/IShaderFormat.h"

Syntax

class IShaderFormat

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IShaderFormat()

 Virtual destructor. Interfaces/IShaderFormat.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AppendToKeyString ( FString& KeyString
) const

 Appends shader key text to the provided key string for use in DDC unique key construction. Interfaces/IShaderFormat.h  

virtual bool CanCompileBinaryShaders()

 Can the shader format compile shaders to the native binary format for the platform. Interfaces/IShaderFormat.h  

virtual bool CanStripShaderCode ( bool const bNativeFormat
) const

 Can this shader format strip shader code for packaging in a shader library? Interfaces/IShaderFormat.h  

virtual void CompilePreprocessedShader ( const FShaderCompilerInput& Input,
const FShaderPreprocessOutput& PrimaryPreprocessOutput,
const FShaderPreprocessOutput& SecondaryPreprocessOutput,
FShaderCompilerOutput& PrimaryOutput,
FShaderCompilerOutput& SecondaryOutput,
const FString& WorkingDirectory
) const

 Compile the specified preprocessed shaders; only called if the call to RequiresSecondaryCompile given the first preprocess output returns true. Interfaces/IShaderFormat.h  

virtual void CompilePreprocessedShader ( const FShaderCompilerInput& Input,
const FShaderPreprocessOutput& PreprocessOutput,
FShaderCompilerOutput& Output,
const FString& WorkingDirectory
) const

 Compile the specified preprocessed shader. Interfaces/IShaderFormat.h  

virtual bool CreateShaderArchive ( FString const& LibraryName,
FName ShaderFormatAndShaderPlatformName,
const FString& WorkingDirectory,
const FString& OutputDir,
const FString& DebugOutputDir,
const FSerializedShaderArchive& SerializedShaders,
const TArray< FSharedBuffer >& ShaderCode,
TArray< FString >* OutputFiles
) const

 Create a format specific archive for precompiled shader code. Interfaces/IShaderFormat.h  

virtual int32 GetPackedShaderKey ()

 Virtual function that can be implemented by backends which require secondary compilation to specify a unique "key" identifier for the packing scheme (for validation in the runtime at load). Interfaces/IShaderFormat.h  

const TCHAR * GetPlatformIncludeDirectory()

 Returns name of directory with platform specific shaders. Interfaces/IShaderFormat.h  

virtual FStringView GetSecondaryCompileName()

 For shader formats which support secondary compilation, this can optionally return a name that is appended to diagnostic messages to distinguish errors in the secondary compile from the primary. Interfaces/IShaderFormat.h  

void GetSupportedFormats ( TArray< FName >& OutFormats
) const

 Gets the list of supported formats. Interfaces/IShaderFormat.h  

uint32 GetVersion ( FName Format
) const

 Gets the current version of the specified shader format. Interfaces/IShaderFormat.h  

virtual void ModifyShaderCompilerInput ( FShaderCompilerInput& Input
) const

 Called before a shader is compiled to allow the platform shader format to modify the shader compiler input, e.g. by adding console variable values relevant to shader compilation on that platform. Interfaces/IShaderFormat.h  

virtual void NotifyShaderCompiled ( const FCompressedBuffer& SymbolData,
FName Format,
const FString& DebugInfo
) const

 Called when a shader resource is cooked, so the shader format can perform platform-specific operations on the debug data. Interfaces/IShaderFormat.h  

virtual void NotifyShaderCompiled ( const TConstArrayView< uint8 >& SymbolData,
FName Format,
const FString& DebugInfo
) const

   Interfaces/IShaderFormat.h  

virtual void NotifyShaderCompilersShutdown ( FName Format
) const

 Called at the end of a cook to free resources and finalize artifacts created during the cook. Interfaces/IShaderFormat.h  

virtual void OutputDebugData ( const FShaderCompilerInput& Input,
const FShaderPreprocessOutput& PreprocessOutput,
const FShaderCompilerOutput& Output,
FShaderDebugDataContext& Ctx
) const

 Implement to output debug info for a single compile job. Interfaces/IShaderFormat.h  

virtual void OutputDebugData ( const FShaderCompilerInput& Input,
const FShaderPreprocessOutput& PreprocessOutput,
const FShaderPreprocessOutput& SecondaryPreprocessOutput,
const FShaderCompilerOutput& Output,
const FShaderCompilerOutput& SecondaryOutput,
FShaderDebugDataContext& Ctx
) const

 Implement to output debug info for the case where a secondary preprocessed shader was created. Interfaces/IShaderFormat.h  

virtual void OutputDebugDataMinimal ( const FShaderCompilerInput& Input,
FShaderDebugDataContext& Ctx
) const

 Implement to output a minimal set of debug info based solely on the compile input. Interfaces/IShaderFormat.h  

virtual bool PreprocessShader ( const FShaderCompilerInput& Input,
const FShaderCompilerEnvironment& Environment,
FShaderPreprocessOutput& PreprocessOutput
) const

 Execute all shader preprocessing steps, storing the output in the PreprocessOutput struct Interfaces/IShaderFormat.h  

virtual bool RequiresSecondaryCompile ( const FShaderCompilerInput& Input,
const FShaderCompilerEnvironment& Environment,
const FShaderPreprocessOutput& PreprocessOutput
) const

 Predicate which should return true if a second preprocess & compilation is required given the initial preprocess output. Interfaces/IShaderFormat.h  

virtual bool StripShaderCode ( TArray< uint8 >& Code,
FString const& DebugOutputDir,
bool const bNative
) const

 Strips the shader bytecode provided of any unnecessary optional data elements when archiving shaders into the shared library. Interfaces/IShaderFormat.h  

virtual bool SupportsShaderArchives()

 Whether this shader format supports a format-specific archive for precompiled shader code. Interfaces/IShaderFormat.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page