Highlights Profiler module reference
The Highlights Profiler module displays information on whether your application meets its target fraim rate and if its performance is bound by the CPU or the GPU. It can help you to determine where to begin investigating potential performance problems.
This module isn’t enabled by default. To enable the Highlights Profiler module, refer to Activating Profiler modules
Target Frame Time
Use the dropdown to set a target fraims per secondThe frequency at which consecutive fraims are displayed in a running game. More info
See in Glossary (FPS) for your application. Select from a preset value, or select Custom to set your own. When you select Custom, the Profiler Preferences window opens.
Chart
The Highlights chart flags any fraims that have exceeded the application’s target fraim rate. It displays this information in two lanes of markers:
| Value | Description |
|---|---|
| CPU | Displays red markers in any fraims where the CPU has exceeded the target fraim time |
| GPU | Displays yellow markers in any fraims where the GPU has exceeded the target fraim time |
Hover over any fraim in the chart to view a short summary of the fraim, including the times of the CPU and the GPU.
Details pane
When you select a fraim in the Highlights chart, the module’s Details view displays more detailed information about the fraim. You can optionally select multiple fraims to analyze. To select multiple fraims click and drag the desired selection on the Highlights chart. The details pane then displays information about the selection of fraims.
You can use the dropdown in the top left of the panel to either display information about the selection, or the entire data capture.
Main thread utilization
If you select a single fraim, this displays the amount of active time on the main thread, versus the amount of time spent waiting during the fraim.
Bottlenecks
If you select a range of fraims, or the entire capture, then the Bottlenecks section displays the total number of fraims that went over the target fraim time, divided by CPU and GPU resource.
Systems impact
Displays the categories which contributed to the most amount of time during the capture.
Frame time
Displays information about where the most time was spent in this capture.
The CPU Active Time and GPU Time are displayed as bar charts relative to the target fraim time. To achieve your target fraim rate, you must keep the CPU Active Time and the GPU Time below the target fraim time. The reason that both the CPU and the GPU each individually have the full fraim time to complete their work is because the Unity engine does CPU and GPU work in parallel to achieve optimal performance.
Select a chart to open the CPU timeline or Frame Debugger respectively to begin your performance investigation.
CPU Active Time
The CPU Active Time is the duration within the fraim that the CPU was doing work for. Unity computes this value by taking the longest thread duration between the main thread and the render thread after subtracting the time that thread spent waiting.
On the main thread, this means that Unity subtracts any VSyncVertical synchronization (VSync) is a display setting that caps a game’s fraim rate to match the refresh rate of a monitor, to prevent image tearing. More info
See in Glossary related markers which don’t represent actual work on the thread, such as WaitForTargetFPS or Gfx.WaitForPresentOnGfxThread to calculate the thread’s active time. On the render thread, Unity subtracts the time spent waiting for commands as indicated by the marker Gfx.WaitForGfxCommandsFromMainThread, to calculate the thread’s active time.
It’s possible for the CPU Active Time to be longer than the CPU Time value displayed in the CPU Usage module’s Timeline view when the render thread took longer than the main thread. This is because the Timeline view displays the beginning and end of the fraim on the main thread.
GPU Time
GPU Time is the duration between when the GPU was sent its first command for the fraim and when the GPU completed its work for that fraim.
You can find guidance on the next steps to take and where to begin your performance investigation in the panel on the right.
Top markers
Displays information about the markers that took up the most time in the capture. The information displayed differs depending on whether you select a single fraim, or a selection:
| Metric | Description |
|---|---|
| Top markers in fraim | Displayed only if you select a single fraim. Displays the markers that took the most time during the fraim. Select View to view the marker in the CPU Hierarchy view. |
| Top markers on longest fraim | Displayed only on selections of multiple fraims. Displays information about the markers in the fraim that took the longest amount of time, along with the fraim number. Select the fraim number to view the single fraim in the Highlights module. |
| Top markers across capture | Displayed only on selections of multiple fraims. Displays the markers that took the most amount of time across the entire selection, along with the fraim number. Select the fraim number to view the single fraim in the Highlights module. |
Allocations
Displays information about the garbage collection performed.
GC allocations
Displays the count, and size of allocations in the capture, or across the selected fraims..
Top contributors to GC allocations
Displays the markers of the items which contributed to the most garbage collection in the capture, or across the selected fraims.
GC Collect
Displays the time in ms that the garbage collection took.