Unity - Scripting API: Unity.Profiling.ProfilerRecorder.ProfilerRecorder
ProfilerRecorder Constructor
Success!
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.
Submission failed
For 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.
Declaration
public ProfilerRecorder(string categoryName, string statName, int capacity, ProfilerRecorderOptions options);
Parameters
| Parameter | Description |
|---|---|
| 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. |
Description
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 don't need to start ProfilerRecorder or allocate sample storage. In this case, use 0 as a capacity parameter when creating ProfilerRecorder.
Using a negative number as a capacity parameter throws ArgumentException.
For a list of built-in Profiler markers and counters available, refer to Profiler markers reference and Profiler counters reference.
Note:
ProfilerRecorder allocates memory and must be disposed when it is no longer needed.
Parameters
| Parameter | Description |
|---|---|
| statName | Profiler marker or counter name. |
| capacity | Maximum amount of samples to be collected. |
| options | Profiler recorder options. |
Description
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.
Parameters
| Parameter | Description |
|---|---|
| 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. |
Description
Constructs ProfilerRecorder instance with a Profiler metric name pointer or other unsafe handles.