r.DumpShaderDebugInfo

r.DumpShaderDebugInfo

#Overview

name: r.DumpShaderDebugInfo

The value of this variable can be defined or overridden in .ini config files. 1 .ini config file referencing this setting variable.

This variable is created as a Console Variable (cvar).

• type: Var
• help: Dumps debug info for compiled shaders to GameName/Saved/ShaderDebugInfo\nWhen set to 1, debug info is dumped for all compiled shader\nWhen set to 2, it is restricted to shaders with compilation errors\nWhen set to 3, it is restricted to shaders with compilation errors or warnings\nThe debug info is platform dependent, but usually includes a preprocessed version of the shader source.\nGlobal shaders automatically dump debug info if r.ShaderDevelopmentMode is enabled, this cvar is not necessary.\nOn iOS, if the PowerVR graphics SDK is installed to the default path, the PowerVR shader compiler will be called and errors will be reported during the cook.

It is referenced in 2 C++ source files.

#Summary

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/ConsoleVariables.ini:42, section: [Startup]

• INI Section: Startup
• Raw value: 2
• Is Array: False

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/ShaderCompiler/ShaderCompiler.cpp:2074

Scope: file

Source code excerpt:

static FShaderCompilingManager::EDumpShaderDebugInfo GDumpShaderDebugInfo = FShaderCompilingManager::EDumpShaderDebugInfo::Never;
static FAutoConsoleVariableRef CVarDumpShaderDebugInfo(
	TEXT("r.DumpShaderDebugInfo"),
	CastEnumToUnderlyingTypeReference(GDumpShaderDebugInfo),
	TEXT("Dumps debug info for compiled shaders to GameName/Saved/ShaderDebugInfo\n")
	TEXT("When set to 1, debug info is dumped for all compiled shader\n")
	TEXT("When set to 2, it is restricted to shaders with compilation errors\n")
	TEXT("When set to 3, it is restricted to shaders with compilation errors or warnings\n")
	TEXT("The debug info is platform dependent, but usually includes a preprocessed version of the shader source.\n")

#Loc: <Workspace>/Engine/Source/Runtime/RenderCore/Public/ShaderCompilerCore.h:276

Scope: file

Source code excerpt:

	// Dump debug path (up to platform) e.g. "D:/Project/Saved/ShaderDebugInfo/PCD3D_SM5"
	FString DumpDebugInfoRootPath;
	// only used if enabled by r.DumpShaderDebugInfo (platform/groupname) e.g. ""
	FString DumpDebugInfoPath;
	// materialname or "Global" "for debugging and better error messages
	FString DebugGroupName;

	FString DebugExtension;