CustomSampler.Create

Parameters

Returns

CustomSampler CustomSampler object or null if a built-in Sampler with the same name exists.

Description

Creates a new CustomSampler for profiling parts of your code.

Multiple calls with the same name parameter return different CustomSampler objects which refer to the same native representation.

Method throws ArgumentNullException when used with null string and ArgumentException when used with existing built-in Profiler label.

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

See Also: CustomSampler.Begin, Sampler.Get.