1. Epic GamesDeveloper
  3. UAutomationPerformaceHelper

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

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
Public variable FFunctionalTestExternalProfiler ExternalProfiler  
Public variable FString OutputFileBase The path and base name for all output files.
Public variable FString StartOfTestingTime  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

BeginRecording ( FString RecordName,
float InGPUBudget,
float InRenderThreadBudget,
float InGameThreadBudget
)

 Begins recording a new named performance stats record. We start by recording the baseline.
Public function void Begins recording a new named performance stats record. We start by recording the baseline
Public function void

BeginStatsFile ( const FString& RecordName
)

 Begins recording stats to a file.
Public function void Stops recording performance stats.
Public function void Stops recording the baseline and moves to the main record.
Public function void Ends recording stats to a file.
Public function Const const FPerfStatsRecord *  
Public function FPerfStatsRecord *  
Public function Virtual Const UWorld *  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Returns true if this stats tracker is currently recording performance stats.
Public function void Does any final work needed as all tests are complete.
Public function void Does any init work across all tests..
Public function void

Sample ( float DeltaSeconds
)

 Adds a sample to the stats counters for the current performance stats record.
Public function void Communicates with external profiler to being a CPU capture.
Public function void Communicates with external profiler to end a CPU capture.
Public function void

Tick ( float DeltaSeconds
)

  
Public function void Will trigger a GPU trace next time the current test falls below GPU budget.
Public function 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

On this page