Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Profiler.EndThreadProfiling

Suggest a change

Success!

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.

Close

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.

Close

Cancel

public static method EndThreadProfiling(): void;
public static void EndThreadProfiling();

Description

Frees the internal resources used by the Profiler for the thread.

The Profiler allocates memory to store information about a thread. To free that memory, call EndThreadProfiling(). Once called, the Profiler stops collecting any data on the thread. Calling this function on the main thread will produce an error.

#pragma strict
var sampler: CustomSampler;
function Start() {
	sampler = CustomSampler.Create("MyCustomSampler");
	var thread: var = new Thread(MyThreadFunc);
	thread.Start();
}
function MyThreadFunc() {
	Profiler.BeginThreadProfiling("My threads", "My thread 1");
	// Now samples will show up in the profiler timeline view
	for (var i: int = 0; i < 10; i++) {
		sampler.Begin();
		// ...
		sampler.End();
	}
	// Unregister the thread before exit
	Profiler.EndThreadProfiling();
}
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(); } }

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