static function BeginSample (name : String) : void

static function BeginSample (name : String, targetObject : Object) : 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 example : MonoBehaviour {
    void Example() {
        Profiler.BeginSample("MyPieceOfCode");
        Profiler.EndSample();
    }
}

import UnityEngine
import System.Collections

class example(MonoBehaviour):

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