Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > FunctionalTesting > UAutomationPerformaceHelper

Light Theme

Dark Theme

UAutomationPerformaceHelper

Class for use with functional tests which provides various performance measuring features.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAutomationPerformaceHelper

References

Module	FunctionalTesting
Header	/Engine/Source/Developer/FunctionalTesting/Classes/FunctionalTest.h
Include	#include "FunctionalTest.h"

Syntax

class UAutomationPerformaceHelper : public UObject

Remarks

Class for use with functional tests which provides various performance measuring features. Recording of basic, unintrusive performance stats. Automatic captures using external CPU and GPU profilers. Triggering and ending of writing full stats to a file.

Variables

	Name	Description
FFunctionalTest...	ExternalProfiler
FString	OutputFileBase	The path and base name for all output files.
FString	StartOfTestingTime

Constructors

	Name	Description
	UAutomationPerformaceHelper()

Functions

	Name	Description
void	BeginRecording ( FString RecordName, float InGPUBudget, float InRenderThreadBudget, float InGameThreadBudget )	Begins recording a new named performance stats record. We start by recording the baseline.
void	BeginRecordingBaseline ( FString RecordName )	Begins recording a new named performance stats record. We start by recording the baseline
void	BeginStatsFile ( const FString& RecordName )	Begins recording stats to a file.
void	EndRecording()	Stops recording performance stats.
void	EndRecordingBaseline()	Stops recording the baseline and moves to the main record.
void	EndStatsFile()	Ends recording stats to a file.
const FPerfS...	GetCurrentRecord()
FPerfStatsRe...	GetCurrentRecord()
UWorld *	GetWorld()
bool	IsCurrentRecordWithinGameThreadBudget()
bool	IsCurrentRecordWithinGPUBudget()
bool	IsCurrentRecordWithinRenderThreadBudget()
bool	IsRecording()	Returns true if this stats tracker is currently recording performance stats.
void	OnAllTestsComplete()	Does any final work needed as all tests are complete.
void	OnBeginTests()	Does any init work across all tests..
void	Sample ( float DeltaSeconds )	Adds a sample to the stats counters for the current performance stats record.
void	StartCPUProfiling()	Communicates with external profiler to being a CPU capture.
void	StopCPUProfiling()	Communicates with external profiler to end a CPU capture.
void	Tick ( float DeltaSeconds )
void	TriggerGPUTraceIfRecordFallsBelowBudget()	Will trigger a GPU trace next time the current test falls below GPU budget.
void	WriteLogFile ( const FString& CaptureDir, const FString& CaptureExtension )	Writes the current set of performance stats records to a csv file in the profiling directory.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss