Class AutomationPerformaceHelper

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

Inheritance
System.Object
UObject
AutomationPerformaceHelper
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.FunctionalTesting
Assembly: UE4DotNet.dll
Syntax
public class AutomationPerformaceHelper : UObject
Remarks

Recording of basic, unintrusive performance stats. Automatic captures using external CPU and GPU profilers. Triggering and ending of writing full stats to a file.

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static AutomationPerformaceHelper DefaultObject { get; }
Property Value
Type Description
AutomationPerformaceHelper
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

BeginRecording(String, Single, Single, Single)

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

Declaration
public void BeginRecording(string RecordName, float InGPUBudget, float InRenderThreadBudget, float InGameThreadBudget)
Parameters
Type Name Description
System.String RecordName
System.Single InGPUBudget
System.Single InRenderThreadBudget
System.Single InGameThreadBudget
| Improve this Doc View Source

BeginRecordingBaseline(String)

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

Declaration
public void BeginRecordingBaseline(string RecordName)
Parameters
Type Name Description
System.String RecordName
| Improve this Doc View Source

BeginStatsFile(String)

Begins recording stats to a file.

Declaration
public void BeginStatsFile(string RecordName)
Parameters
Type Name Description
System.String RecordName
| Improve this Doc View Source

EndRecording()

Stops recording performance stats.

Declaration
public void EndRecording()
| Improve this Doc View Source

EndRecordingBaseline()

Stops recording the baseline and moves to the main record.

Declaration
public void EndRecordingBaseline()
| Improve this Doc View Source

EndStatsFile()

Ends recording stats to a file.

Declaration
public void EndStatsFile()
| Improve this Doc View Source

IsCurrentRecordWithinGameThreadBudget()

Is Current Record Within Game Thread Budget

Declaration
public bool IsCurrentRecordWithinGameThreadBudget()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsCurrentRecordWithinGPUBudget()

Is Current Record Within GPUBudget

Declaration
public bool IsCurrentRecordWithinGPUBudget()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsCurrentRecordWithinRenderThreadBudget()

Is Current Record Within Render Thread Budget

Declaration
public bool IsCurrentRecordWithinRenderThreadBudget()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsRecording()

Returns true if this stats tracker is currently recording performance stats.

Declaration
public bool IsRecording()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static AutomationPerformaceHelper New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
AutomationPerformaceHelper
| Improve this Doc View Source

OnAllTestsComplete()

Does any final work needed as all tests are complete.

Declaration
public void OnAllTestsComplete()
| Improve this Doc View Source

OnBeginTests()

Does any init work across all tests..

Declaration
public void OnBeginTests()
| Improve this Doc View Source

Sample(Single)

Adds a sample to the stats counters for the current performance stats record.

Declaration
public void Sample(float DeltaSeconds)
Parameters
Type Name Description
System.Single DeltaSeconds
| Improve this Doc View Source

StartCPUProfiling()

Communicates with external profiler to being a CPU capture.

Declaration
public void StartCPUProfiling()
| Improve this Doc View Source

StopCPUProfiling()

Communicates with external profiler to end a CPU capture.

Declaration
public void StopCPUProfiling()
| Improve this Doc View Source

Tick(Single)

Begin basic stat recording

Declaration
public void Tick(float DeltaSeconds)
Parameters
Type Name Description
System.Single DeltaSeconds
| Improve this Doc View Source

TriggerGPUTraceIfRecordFallsBelowBudget()

Will trigger a GPU trace next time the current test falls below GPU budget.

Declaration
public void TriggerGPUTraceIfRecordFallsBelowBudget()
| Improve this Doc View Source

WriteLogFile(String, String)

Writes the current set of performance stats records to a csv file in the profiling directory. An additional directory and an extension override can also be used.

Declaration
public void WriteLogFile(string CaptureDir, string CaptureExtension)
Parameters
Type Name Description
System.String CaptureDir
System.String CaptureExtension

Operators

| Improve this Doc View Source

Implicit(IntPtr to AutomationPerformaceHelper)

Convert from IntPtr to UObject

Declaration
public static implicit operator AutomationPerformaceHelper(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
AutomationPerformaceHelper