t.FPSChart.OpenFolderOnDump

t.FPSChart.OpenFolderOnDump

#Overview

name: t.FPSChart.OpenFolderOnDump

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

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of t.FPSChart.OpenFolderOnDump is to control whether the folder containing FPS chart logs and other related files should be automatically opened when a performance dump is finished. This setting is primarily used for the performance monitoring and profiling system in Unreal Engine 5.

This setting variable is utilized by the Engine module, specifically within the performance tracking and chart creation subsystem. It’s referenced in the ChartCreation.cpp file, which is part of the Engine’s runtime.

The value of this variable is set through a console variable system. It’s initialized with a default value of 1 (enabled) but can be changed at runtime through console commands or configuration files.

The associated variable GFPSChartOpenFolderOnDump directly interacts with t.FPSChart.OpenFolderOnDump. They share the same value and purpose, with GFPSChartOpenFolderOnDump being the C++ representation of the console variable.

Developers should be aware that this variable is primarily intended for desktop platforms, as indicated by the PLATFORM_DESKTOP conditional compilation directive. It’s also designed to be disabled for automated testing scenarios, allowing for unattended performance data collection without opening folders automatically.

Best practices when using this variable include:

  1. Leave it enabled (default value of 1) during development for quick access to performance logs.
  2. Disable it (set to 0) when running automated tests or on non-desktop platforms.
  3. Use it in conjunction with other FPS charting and profiling tools for a comprehensive performance analysis workflow.

Regarding the associated variable GFPSChartOpenFolderOnDump:

This is the C++ representation of the t.FPSChart.OpenFolderOnDump console variable. It’s defined as a static TAutoConsoleVariable, which means it’s a global variable that can be accessed and modified through the console system.

The purpose and usage of GFPSChartOpenFolderOnDump are identical to t.FPSChart.OpenFolderOnDump. It’s used within the C++ code to check the current value of the setting and determine whether to open the folder containing performance logs.

Developers should be aware that while they can directly access GFPSChartOpenFolderOnDump in C++ code, it’s generally better practice to use the console variable system (via IConsoleManager) to modify its value, ensuring consistency across the engine’s subsystems.

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/ChartCreation.cpp:45

Scope: file

Source code excerpt:

// Should we explore to the folder that contains the .log / etc... when a dump is finished?  This can be disabled for automated testing
static TAutoConsoleVariable<int32> GFPSChartOpenFolderOnDump(
	TEXT("t.FPSChart.OpenFolderOnDump"),
	1,
	TEXT("Should we explore to the folder that contains the .log / etc... when a dump is finished?  This can be disabled for automated testing\n")
	TEXT(" default: 1"));

#if FPS_CHART_SUPPORT_CSV_PROFILE
/** Are we recording a CSV profile? */

#Associated Variable and Callsites

This variable is associated with another variable named GFPSChartOpenFolderOnDump. They share the same value. See the following C++ source code.

#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/ChartCreation.cpp:44

Scope: file

Source code excerpt:


// Should we explore to the folder that contains the .log / etc... when a dump is finished?  This can be disabled for automated testing
static TAutoConsoleVariable<int32> GFPSChartOpenFolderOnDump(
	TEXT("t.FPSChart.OpenFolderOnDump"),
	1,
	TEXT("Should we explore to the folder that contains the .log / etc... when a dump is finished?  This can be disabled for automated testing\n")
	TEXT(" default: 1"));

#if FPS_CHART_SUPPORT_CSV_PROFILE

#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/ChartCreation.cpp:903

Scope (from outer to inner):

file
function     void FPerformanceTrackingChart::DumpChartsToLogFile

Source code excerpt:


#if	PLATFORM_DESKTOP
		if (GFPSChartOpenFolderOnDump.GetValueOnGameThread())
		{
			FPlatformProcess::ExploreFolder(*AbsolutePath);
		}
#endif
	}
}