UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
CsvProfilerConfig.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "Misc/Build.h"
6
7// Whether to allow the CSV profiler in shipping builds.
8// Enable in a .Target.cs file if required.
9#ifndef CSV_PROFILER_ENABLE_IN_SHIPPING
10#define CSV_PROFILER_ENABLE_IN_SHIPPING 0
11#endif
12
13// Enables command line switches and unit tests of the CSV profiler.
14// The default disables these features in a shipping build, but a .Target.cs file can override this.
15#ifndef CSV_PROFILER_ALLOW_DEBUG_FEATURES
16#define CSV_PROFILER_ALLOW_DEBUG_FEATURES (!UE_BUILD_SHIPPING)
17#endif
18
19#ifndef CSV_PROFILER_USE_CUSTOM_FRAME_TIMINGS
20#define CSV_PROFILER_USE_CUSTOM_FRAME_TIMINGS 0
21#endif
22
23// Enable this to run the CSV profiler with near-zero instrumentation overhead. Only a handful of key stats will be captured
24#ifndef CSV_PROFILER_MINIMAL
25#define CSV_PROFILER_MINIMAL 0
26#endif
27
28
29// CSV_PROFILER default enabling rules, if not specified explicitly in <Program>.Target.cs GlobalDefinitions
30#ifndef CSV_PROFILER
31 #define CSV_PROFILER (WITH_ENGINE && (!UE_BUILD_SHIPPING || CSV_PROFILER_ENABLE_IN_SHIPPING))
32#endif
33
34// CSV_PROFILER_STATS is disabled if CSV_PROFILER_MINIMAL is enabled. Profiling subsystems should be predicated on this rather than CSV_PROFILER
35#define CSV_PROFILER_STATS (CSV_PROFILER && !CSV_PROFILER_MINIMAL)