Profiler.BeginSample

static function BeginSample(name: string): void;

static void BeginSample(string name);

static def BeginSample(name as string) as void

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

static void BeginSample(string name, Object targetObject);

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()

Script language:

Script language

Scripting API

Profiler.BeginSample

Description