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.
elapsedNanoseconds | Accumulated time of Begin/End pairs for the previous frame in nanoseconds. (Read Only) |
enabled | Enables recording. |
gpuElapsedNanoseconds | Gets the accumulated GPU time, in nanoseconds, for a frame. The Recorder has a three frame delay so this gives the timings for the frame that was three frames before the one that you access this property on. (Read Only). |
gpuSampleBlockCount | Gets the number of Begin/End time pairs that the GPU executed during a frame. The Recorder has a three frame delay so this gives the timings for the frame that was three frames before the one that you access this property on. (Read Only). |
isValid | Returns true if Recorder is valid and can collect data. (Read Only) |
sampleBlockCount | Number of time Begin/End pairs was called during the previous frame. (Read Only) |
CollectFromAllThreads | Configures the recorder to collect samples from all threads. |
FilterToCurrentThread | Configures the recorder to only collect data from the current thread. |
Get | Use this function to get a Recorder for the specific Profiler label. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.