Gets the description of a Profiler metric.
Provides information about Profiler metrics that are accessible with the ProfilerRecorder. Use Name and Category to create an instance of ProfilerRecorder.
using System.Collections.Generic; using System.Text; using UnityEngine; using Unity.Profiling; using Unity.Profiling.LowLevel.Unsafe;
public class Example { struct StatInfo { public ProfilerCategory Cat; public string Name; public ProfilerMarkerDataUnit Unit; }
static unsafe void EnumerateProfilerStats() { var availableStatHandles = new List<ProfilerRecorderHandle>(); ProfilerRecorderHandle.GetAvailable(availableStatHandles);
var availableStats = new List<StatInfo>(availableStatHandles.Count); foreach (var h in availableStatHandles) { var statDesc = ProfilerRecorderHandle.GetDescription(h); var statInfo = new StatInfo() { Cat = statDesc.Category, Name = statDesc.Name, Unit = statDesc.UnitType }; availableStats.Add(statInfo); } availableStats.Sort((a, b) => { var result = string.Compare(a.Cat.ToString(), b.Cat.ToString()); if (result != 0) return result;
return string.Compare(a.Name, b.Name); });
var sb = new StringBuilder("Available stats:\n"); foreach (var s in availableStats) { sb.AppendLine($"{(int)s.Cat}\t\t - {s.Name}\t\t - {s.Unit}"); }
Debug.Log(sb.ToString()); } }
Category | Gets the ProfilerCategory value of the Profiler metric. |
DataType | Gets the data value type of the Profiler metric. |
Flags | Profiler marker flags of the metric. |
Name | The name of the Profiler metric. |
NameUtf8 | The name of the Profiler metric as a pointer to UTF-8 byte array. |
NameUtf8Len | Name length excluding null terminator. |
UnitType | Gets the data unit type of the Profiler metric. |
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.