1. Epic GamesDeveloper
  3. IShaderFormat

IShaderFormat

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

API > API/Developer > API/Developer/TargetPlatform > API/Developer/TargetPlatform/Interfaces

Inheritance Hierarchy

References

   
Module TargetPlatform
Header /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h
Include #include "Interfaces/IShaderFormat.h"

Syntax

class IShaderFormat

Remarks

IShaderFormat, shader pre-compilation abstraction

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function Virtual Const void

AppendToKeyString ( FString& KeyString
)

 Appends shader key text to the provided key string for use in DDC unique key construction.
Public function Virtual Const bool Can the shader format compile shaders to the native binary format for the platform.
Public function Virtual Const bool

CanStripShaderCode ( bool const bNativeFormat
)

 Can this shader format strip shader code for packaging in a shader library?
Public function Virtual Const void

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

 Compile the specified preprocessed shaders; only called if SupportsIndependentPreprocessing returns true, and the call to RequiresSecondaryCompile given the first preprocess output also returns true.
Public function Virtual Const void

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

 Compile the specified preprocessed shader; only called if SupportsIndependentPreprocessing returns true
Public function Virtual Const void

CompileShader ( FName Format,
const FShaderCompilerInput& Input,
FShaderCompilerOutput& Output,
const FString& WorkingDirectory
)

 Compile the specified shader. Only called if SupportsIndependentPreprocessing returns false.
Public function Virtual Const bool

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

 Create a format specific archive for precompiled shader code.
Public function Virtual Const int32 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).
Public function Const const TCHAR * Returns name of directory with platform specific shaders.
Public function Const void

GetSupportedFormats ( TArray< FName >& OutFormats
)

 Gets the list of supported formats.
Public function Const uint32

GetVersion ( FName Format
)

 Gets the current version of the specified shader format.
Public function Virtual Const void 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.
Public function Virtual Const void

NotifyShaderCompiled ( const TConstArrayView< uint8 >& PlatformDebugData,
FName Format
)

 Called when a shader resource is cooked, so the shader format can perform platform-specific operations on the debug data.
Public function Virtual Const void Called at the end of a cook to free resources and finalize artifacts created during the cook.
Public function Virtual Const void

OutputDebugData ( const FShaderCompilerInput& Input,
const FShaderPreprocessOutput& PreprocessOutput,
const FShaderCompilerOutput& Output
)

 Implement to output debug info for a single compile job; only called if SupportsIndependentPreprocessing returns true.
Public function Virtual Const void

OutputDebugData ( const FShaderCompilerInput& Input,
const FShaderPreprocessOutput& PreprocessOutput,
const FShaderPreprocessOutput& SecondaryPreprocessOutput,
const FShaderCompilerOutput& Output,
const FShaderCompilerOutput& SecondaryOutput
)

 Implement to output debug info for the case where a secondary preprocessed shader was created.
Public function Virtual Const bool

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

 Executes all shader preprocessing steps; only called if SupportsIndependentPreprocessing returns true
Public function Virtual Const bool

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

 Predicate which should return true if a second preprocess & compilation is required given the initial preprocess output.
Public function Virtual Const bool

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

 Strips the shader bytecode provided of any unnecessary optional data elements when archiving shaders into the shared library.
Public function Virtual Const bool Return true if preprocessing for this format can be executed independent of compilation (i.e. the format has an implementation of the PreprocessShader function).
Public function Virtual Const bool Whether this shader format supports a format-specific archive for precompiled shader code.

Deprecated Functions

  Type Name Description
Public function Virtual Const bool

UsesHLSLcc ( const FShaderCompilerInput& Input
)

 UsesHLSLcc function is no longer used

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page