categoryName | Profiler category name. |
statName | Profiler marker or counter name. |
capacity | Maximum amount of samples to be collected. |
options | Profiler recorder options. |
category | Profiler category identifier. |
Constructs ProfilerRecorder instance with a Profiler metric name and category.
Use to initialize ProfilerRecorder and associate it with a specific Profiler metric.
By default, ProfilerRecorder does not start collecting data immediately. Use ProfilerRecorderOptions.StartImmediately to enable collection together with ProfilerRecorder construction. Alternatively, use Start method after construction.
If the CurrentValue is the only data you are interested in, you do not need to start ProfilerRecorder or allocate sample storage. In this case, use 0 as a capacity parameter when creating ProfilerRecorder.
Note:
ProfilerRecorder allocates memory and must be disposed when it is no longer needed.
using Unity.Profiling; using UnityEngine;
public class ExampleScript : MonoBehaviour { ProfilerRecorder systemMemoryRecorder; ProfilerRecorder gcMemoryRecorder; ProfilerRecorder mainThreadTimeRecorder;
void OnEnable() { systemMemoryRecorder = new ProfilerRecorder(ProfilerCategory.Memory, "System Used Memory", 1, ProfilerRecorderOptions.Default | ProfilerRecorderOptions.StartImmediately); gcMemoryRecorder = new ProfilerRecorder(ProfilerCategory.Memory, "GC Reserved Memory", 1, ProfilerRecorderOptions.Default | ProfilerRecorderOptions.StartImmediately); mainThreadTimeRecorder = new ProfilerRecorder(ProfilerCategory.Internal, "Main Thread", 15); mainThreadTimeRecorder.Start(); }
void OnDisable() { systemMemoryRecorder.Dispose(); gcMemoryRecorder.Dispose(); mainThreadTimeRecorder.Dispose(); } }
See Also: StartNew.
statName | Profiler marker or counter name. |
capacity | Maximum amount of samples to be collected. |
options | Profiler recorder options. |
Constructs ProfilerRecorder instance with a Profiler metric name.
Use to initialize ProfilerRecorder with a metric name only. Unity searches for the metric name across all categories, and as such, initialization is slower than if you specify a category.
category | Profiler category identifier. |
statName | Profiler marker or counter name pointer. |
statNameLen | Profiler marker or counter name length. |
capacity | Maximum amount of samples to be collected. |
options | Profiler recorder options. |
marker | Profiler marker instance. |
statHandle | Profiler recorder handle. |
Constructs ProfilerRecorder instance with a Profiler metric name pointer or other unsafe handles.
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.