Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

ProfilerRecorder.Start

Declaration

public void Start();

Description

Start data collection.

Newly constructed recorder is not collecting samples unless ProfilerRecorderOptions.StartImmediately option is specified. Use Start to attach ProfilerRecorder to the Profiler metric and start data collection.

Note: Starting recorder which has 0 Capacity throws InvalidOperationException.

using Unity.Profiling;
using UnityEngine;

public class ExampleScript : MonoBehaviour { ProfilerRecorder mainThreadTimeRecorder;

void OnEnable() { mainThreadTimeRecorder = new ProfilerRecorder(ProfilerCategory.Internal, "Main Thread", 15); mainThreadTimeRecorder.Start(); }

void OnDisable() { mainThreadTimeRecorder.Dispose(); } }

When you don't need data to be collected use Stop to detach recorder from counter or marker. And Dispose to free unmanaged resources.