threadGroupName | The name of the thread group to which the thread belongs. |
threadName | The 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.
Note:
Calling this method on an internal Unity thread (such as main thread, render thread or job system threads) has no effect.
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:
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.