struct in Unity.Profiling
/
Implemented in:UnityEngine.CoreModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseRecords the Profiler metric data that a Profiler marker or counter produces.
Use ProfilerRecorder to access performance metrics that the Profiler exposes. You can use it to read Profiler counter data such as memory or render statistics, and Profiler marker timing data in a uniform way.
You can use this API in Editor and Player builds, including Release Players.
Use ProfilerRecorderHandle.GetAvailable to get the full list of supported metrics.
For a list of built-in Profiler markers available, see the User Manual documentation on Common Profiler markers.
The following example demonstrates how you can use ProfilerRecorder to get memory and timing statistics.
using System.Collections.Generic; using System.Text; using Unity.Profiling; using UnityEngine;
public class ExampleScript : MonoBehaviour { string statsText; ProfilerRecorder systemMemoryRecorder; ProfilerRecorder gcMemoryRecorder; ProfilerRecorder mainThreadTimeRecorder;
static double GetRecorderFrameAverage(ProfilerRecorder recorder) { var samplesCount = recorder.Capacity; if (samplesCount == 0) return 0;
double r = 0; unsafe { var samples = stackalloc ProfilerRecorderSample[samplesCount]; recorder.CopyTo(samples, samplesCount); for (var i = 0; i < samplesCount; ++i) r += samples[i].Value; r /= samplesCount; }
return r; }
void OnEnable() { systemMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "System Used Memory"); gcMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "GC Reserved Memory"); mainThreadTimeRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Internal, "Main Thread", 15); }
void OnDisable() { systemMemoryRecorder.Dispose(); gcMemoryRecorder.Dispose(); mainThreadTimeRecorder.Dispose(); }
void Update() { var sb = new StringBuilder(500); sb.AppendLine($"Frame Time: {GetRecorderFrameAverage(mainThreadTimeRecorder) * (1e-6f):F1} ms"); sb.AppendLine($"GC Memory: {gcMemoryRecorder.LastValue / (1024 * 1024)} MB"); sb.AppendLine($"System Memory: {systemMemoryRecorder.LastValue / (1024 * 1024)} MB"); statsText = sb.ToString(); }
void OnGUI() { GUI.TextArea(new Rect(10, 30, 250, 50), statsText); } }
Note:
ProfilerRecorder allocates unmanaged resources and implements IDisposable interface. Use Dispose to free resources when you no longer need to record statistics.
ProfilerRecorder gives you access to Unity metrics in two modes: immediate access to a value of a counter, and the counter value when the frame ends.
Additional resources: CurrentValue, LastValue, GetSample, ProfilerRecorderHandle.GetAvailable.
Capacity | Maximum amount of samples ProfilerRecorder can capture. |
Count | Collected samples count. |
CurrentValue | Gets current value of the Profiler metric. |
CurrentValueAsDouble | Gets current value of the Profiler metric as double value. |
DataType | Value data type of the Profiler metric. |
IsRunning | Indicates if ProfilerRecorder is attached to the Profiler metric. |
LastValue | Gets the last value collected by the ProfilerRecorder. |
LastValueAsDouble | Gets the last value collected by the ProfilerRecorder as double. |
UnitType | Unit type. |
Valid | Indicates whether ProfilerRecorder is associated with a valid Profiler marker or counter. |
WrappedAround | Indicates if ProfilerRecorder capacity has been exceeded. |
ProfilerRecorder | Constructs ProfilerRecorder instance with a Profiler metric name and category. |
CopyTo | Copies collected samples to the destination array. |
Dispose | Releases unmanaged instance of the ProfilerRecorder. |
GetSample | Gets sample data. |
Reset | Stops data collection and clears collected samples. |
Start | Start data collection. |
Stop | Stops data collection. |
ToArray | Use to convert collected samples to an array. |
StartNew | Initialize a new instance of ProfilerRecorder and start data collection. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.