Perf

Perf

Windows
MacOS
Linux
On this page

Actions

Begin Recording

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

Target is Automation Performace Helper

Begin Recording Baseline

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

Target is Automation Performace Helper

Begin Stats File

Begins recording stats to a file.

Target is Automation Performace Helper

End Recording

Stops recording performance stats.

Target is Automation Performace Helper

End Recording Baseline

Stops recording the baseline and moves to the main record.

Target is Automation Performace Helper

End Stats File

Ends recording stats to a file.

Target is Automation Performace Helper

Is Current Record Within Game Thread Budget

Is Current Record Within Game Thread Budget

Target is Automation Performace Helper

Is Current Record Within GPUBudget

Is Current Record Within GPUBudget

Target is Automation Performace Helper

Is Current Record Within Render Thread Budget

Is Current Record Within Render Thread Budget

Target is Automation Performace Helper

Is Recording

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

Target is Automation Performace Helper

On All Tests Complete

Does any final work needed as all tests are complete.

Target is Automation Performace Helper

On Begin Tests

Does any init work across all tests..

Target is Automation Performace Helper

Sample

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

Target is Automation Performace Helper

Start CPUProfiling

Communicates with external profiler to being a CPU capture.

Target is Automation Performace Helper

Stop CPUProfiling

Communicates with external profiler to end a CPU capture.

Target is Automation Performace Helper

Tick

Begin basic stat recording

Target is Automation Performace Helper

Trigger GPUTrace if Record Falls Below Budget

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

Target is Automation Performace Helper

Write Log File

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.

Target is Automation Performace Helper

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback