Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

CustomSampler.Begin

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 method Begin(): void;
public void Begin();
public method Begin(targetObject: Object): void;
public void Begin(Object targetObject);

Description

Begin profiling a piece of code with a custom label defined by this instance of CustomSampler.

This will show up in the Profiler hierarchy.

#pragma strict
var sampler: CustomSampler;
function Start() {
	sampler = CustomSampler.Create("MyCustomSampler");
}
function Update() {
	sampler.Begin();
	// do something that takes a lot of time
	sampler.End();
}
using UnityEngine;
using UnityEngine.Profiling;

public class ExampleClass : MonoBehaviour { CustomSampler sampler; void Start() { sampler = CustomSampler.Create("MyCustomSampler"); }

void Update() { sampler.Begin(); // do something that takes a lot of time sampler.End(); } }

Profiler.BeginSample is conditionally compiled away using ConditionalAttribute. Thus it will have zero overhead, when it is deployed in non-Development Build.

See Also: CustomSampler.End, CustomSampler.Create, ProfilerCPU.