Version: 2018.2 (switch to 2018.1 or 2017.4)
  • C#


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.



public static void BeginThreadProfiling(string threadGroupName, string threadName);


threadGroupNameThe name of the thread group to which the thread belongs.
threadNameThe name of the thread.


Enables profiling on the thread from which you call this method.

Makes the thread show up with its registered name in the Profiler Timeline View, showing the duration of each sample on the thread. Samples which cross frame boundaries are sliced and might contribute time to multiple frames.

Multiple calls of BeginThreadProfiling on the same thread have no effect. You can only set group and name once. Calling this function on the main thread will produce an error.

using UnityEngine;
using UnityEngine.Profiling;
using System.Threading;

public class ExampleClass : MonoBehaviour { CustomSampler sampler; void Start() { sampler = CustomSampler.Create("MyCustomSampler"); var thread = new Thread(MyThreadFunc) { IsBackground = true }; thread.Start(); }

void MyThreadFunc() { Profiler.BeginThreadProfiling("My threads", "My thread 1"); // Now samples will show up in the profiler timeline view for (int i = 0; i < 10; i++) { sampler.Begin(); // ... sampler.End(); }

// Unregister the thread before exit Profiler.EndThreadProfiling(); } }

Note: Profiler.EndThreadProfiling should always be called before thread destruction to free internal resources.

See Also: Profiler.EndThreadProfiling, CustomSampler.

Did you find this page useful? Please give it a rating: