Navigation
API > API/Developer > API/Developer/TargetPlatform > API/Developer/TargetPlatform/IShaderFormat
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OutputDebugData
(
const FShaderCompilerInput& Input, |
Implement to output debug info for a single compile job. | Interfaces/IShaderFormat.h | |
virtual void OutputDebugData
(
const FShaderCompilerInput& Input, |
Implement to output debug info for the case where a secondary preprocessed shader was created. | Interfaces/IShaderFormat.h |
OutputDebugData(const FShaderCompilerInput &, const FShaderPreprocessOutput &, const FShaderCompilerOutput &, FShaderDebugDataContext &)
Description
Implement to output debug info for a single compile job. This will be called for all jobs (including those found in the job cache) but only if debug info is enabled for the job. Note that any debug info output in CompilePreprocessedShader will only be done for the job that actually executes the compile step, as such any debug outputs that are desirable for all jobs should be written by this function. A BaseShaderFormat implementation is provided in ShaderCompilerCommon which dumps preprocessed and stripped USFs along with the hash of the shader code in an OutputHash.txt file; if no additional custom debug output is required the shader format can inherit from FBaseShaderFormat instead of IShaderFormat.
| Name | OutputDebugData |
| Type | function |
| Header File | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h |
| Include Path | #include "Interfaces/IShaderFormat.h" |
virtual void OutputDebugData
(
const FShaderCompilerInput & Input,
const FShaderPreprocessOutput & PreprocessOutput,
const FShaderCompilerOutput & Output,
FShaderDebugDataContext & Ctx
) const
OutputDebugData(const FShaderCompilerInput &, const FShaderPreprocessOutput &, const FShaderPreprocessOutput &, const FShaderCompilerOutput &, const FShaderCompilerOutput &, FShaderDebugDataContext &)
Description
Implement to output debug info for the case where a secondary preprocessed shader was created. As with the dual-output version of CompilePreprocessedShader this is provided so shader formats can statically distinguish the single and dual output cases. Note that BaseShaderFormat does not provide an implementation of this so it needs to be explicitly implemented by backends which require secondary compilation, even if inheriting from FBaseShaderFormat.
| Name | OutputDebugData |
| Type | function |
| Header File | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h |
| Include Path | #include "Interfaces/IShaderFormat.h" |
virtual void OutputDebugData
(
const FShaderCompilerInput & Input,
const FShaderPreprocessOutput & PreprocessOutput,
const FShaderPreprocessOutput & SecondaryPreprocessOutput,
const FShaderCompilerOutput & Output,
const FShaderCompilerOutput & SecondaryOutput,
FShaderDebugDataContext & Ctx
) const