Profiler.BeginThreadProfiling

Parameters

Description

Enables profiling on the thread which calls 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 boundary 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 the 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.