UAutomationPerformaceHelper

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

Unreal Engine C++ API Reference > Developer > FunctionalTesting

Inheritance Hierarchy

References

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

Syntax

class UAutomationPerformaceHelper : public [UObject](API\Runtime\CoreUObject\UObject\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

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

Constructors

Type Name Description
  UAutomationPerformaceHelper ()  

Functions

Type 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library