Version: 2019.4
  • C#


class in UnityEngine.Profiling


Implemented in:UnityEngine.CoreModule

Suggest a change


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.




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.


elapsedNanosecondsAccumulated time of Begin/End pairs for the previous frame in nanoseconds. (Read Only)
enabledEnables recording.
isValidReturns true if Recorder is valid and can collect data. (Read Only)
sampleBlockCountNumber of time Begin/End pairs was called during the previous frame. (Read Only)

Public Methods

CollectFromAllThreadsConfigures the recorder to collect samples from all threads.
FilterToCurrentThreadConfigures the recorder to only collect data from the current thread.

Static Methods

GetUse this function to get a Recorder for the specific Profiler label.