Recorder

Description

Records profiling data produced by a specific Sampler.

Recorder accumulates elapsed time of every Begin/End pair during a frame. Once enabled it sums delta time between Begin and End samples produced by a Sampler. Use elapsedNanoseconds to get the accumulated time for the previous frame.

using UnityEngine;
using UnityEngine.Profiling;

public class ExampleClass : MonoBehaviour
{
    Recorder behaviourUpdateRecorder;
    void Start()
    {
        behaviourUpdateRecorder = Recorder.Get("BehaviourUpdate");
        behaviourUpdateRecorder.enabled = true;
    }

    void Update()
    {
        if (behaviourUpdateRecorder.isValid)
            Debug.Log("BehaviourUpdate time: " + behaviourUpdateRecorder.elapsedNanoseconds);
    }
}

Note: A Recorder collects data regardless of the Profiler state. When a Recorder is enabled, data is accumulated every time its Sampler is hit. This information is equivalent to the one you can see in Hierarchy view in the Profiler Window.

At the moment Samplers are available only in the Editor and Development Players. Use Recorder.isValid to verify if Recorder can collect the data.

Recorder supports only internal static Profiler labels and labels generated by CustomSampler. Dynamic internal labels produced by scripting method calls and labels produced by Profiler.BeginSample are not supported.

See Also: Sampler, Recorder.isValid, Recorder.elapsedNanoseconds.

Variables

Static Functions