Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

Profiler.BeginSample

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function BeginSample(name: string): void;
public static void BeginSample(string name);
public static def BeginSample(name as string) as void
public static function BeginSample(name: string, targetObject: Object): void;
public static void BeginSample(string name, Object targetObject);
public static def BeginSample(name as string, targetObject as Object) as void

Description

Begin profiling a piece of code with a custom label.

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

	Profiler.BeginSample ("MyPieceOfCode");
	// do something that takes a lot of time
	Profiler.EndSample ();

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Example() {
        Profiler.BeginSample("MyPieceOfCode");
        Profiler.EndSample();
    }
}

import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Example() as void:
		Profiler.BeginSample('MyPieceOfCode')
		Profiler.EndSample()

See Also: Profiler.EndSample, Profiler.

Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload