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.
CloseProfilerRecorder sample data structure.
Use to get a value of the specific sample and count of subsamples for accumulated values.
using Unity.Profiling; using UnityEngine;
public class FrameTimeScript : MonoBehaviour { ProfilerRecorder gcAllocCountPerFrameRecorder;
void OnEnable() { gcAllocCountPerFrameRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "GC.Alloc", // Set recorder buffer size 30, // Collect 30 values // Set buffer behavior to be round-robin ProfilerRecorderOptions.WrapAroundWhenCapacityReached | // 30 values become last 30 values // All samples in a frame will be summed up and put into a buffer as a single value ProfilerRecorderOptions.SumAllSamplesInFrame); // 30 last values become 30 last frame values of accumulated per-frame GC.Collect samples on all threads }
void OnDisable() { // Always dispose recorder when not needed to avoid memory leak and additional calculations gcAllocCountPerFrameRecorder.Dispose(); }
double CalculateAverageCountPerFrame(ProfilerRecorder r) { int count = r.Count; double acc = 0; for (var i = 0; i < count; ++i) { // Get the number of GC.Count samples that were accumulated per frame acc += r.GetSample(i).Count; } return count > 0 ? acc / count : 0; }
void OnGUI() { GUI.TextArea(new Rect(10, 30, 350, 20), $"GC.Alloc count: {CalculateAverageCountPerFrame(gcAllocCountPerFrameRecorder)}"); } }
Additional resources: ProfilerRecorder, ProfilerRecorder.GetSample.
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.