FBaseShaderFormat::OutputDebugData

Implement to output debug info for a single compile job; only called if SupportsIndependentPreprocessing returns true.

Unreal Engine C++ API Reference > Developer > ShaderCompilerCommon > FBaseShaderFormat

References

   
Module ShaderCompilerCommon
Header /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h
Include #include "ShaderCompilerCommon.h"
Source /Engine/Source/Developer/ShaderCompilerCommon/Private/ShaderCompilerCommon.cpp
virtual void OutputDebugData
(
    const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input,
    const [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & PreprocessOutput,
    const [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output
) const

Remarks

Implement to output debug info for a single compile job; only called if SupportsIndependentPreprocessing returns true. 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.


Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library