StartNew
Initialize a new instance of ProfilerRecorder and start data collection.
Read time 1 minuteLast updated 12 days ago
Definition
- Type: Method
- Namespace: Unity.Profiling
- Assembly: UnityEngine.CoreModule
StartNew(ProfilerCategory, string, int, ProfilerRecorderOptions)
Initialize a new instance of ProfilerRecorder and start data collection.
public static ProfilerRecorder StartNew(ProfilerCategory category, string statName, int capacity = 1, ProfilerRecorderOptions options = ProfilerRecorderOptions.Default)
Parameters
Profiler category.
Profiler marker or counter name.
Maximum amount of samples to be collect. Must be greater than 0.
ProfilerRecorder options.
Returns
Type | Description |
|---|---|
| ProfilerRecorder | Returns new enabled recorder instance. |
Remarks
For a list of built-in Profiler markers available, see the User Manual documentation on Common Profiler markers.
Note: capacity paramether must be greater than 0, otherwise StartNew throws an exception.
using Unity.Profiling;using UnityEngine;public class ExampleScript : MonoBehaviour{ ProfilerRecorder systemMemoryRecorder; ProfilerRecorder gcMemoryRecorder; ProfilerRecorder mainThreadTimeRecorder; 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(); }}
Additional Resources: ctor.
StartNew(ProfilerMarker, int, ProfilerRecorderOptions)
Initialize a new instance of ProfilerRecorder for ProfilerMarker and start data collection.
public static ProfilerRecorder StartNew(ProfilerMarker marker, int capacity = 1, ProfilerRecorderOptions options = ProfilerRecorderOptions.Default)
Parameters
Profiler marker instance.
Maximum amount of samples to be collected. Must be greater than 0.
Profiler recorder options.
Returns
Type | Description |
|---|---|
| ProfilerRecorder | Returns new enabled recorder instance. |
Remarks
Additional Resources:: ProfilerMarker.