Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Create(string, bool)

Creates a new CustomSampler for profiling parts of your code.
Read time 1 minuteLast updated 6 days ago

Definition

public static CustomSampler Create(string name, bool collectGpuData = false)

Parameters

name

string
Name of the Sampler.

collectGpuData

bool
Specifies whether this Sampler records GPU timings. If you want the Sampler to record GPU timings, set this to true.

Returns

Type

Description

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

Remarks

Multiple calls with the same name parameter return different CustomSampler objects which refer to the same native representation. CustomSampler represents scripting profiler label.
Method throws ArgumentNullException when used with null string.
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();    }}
Additional Resources: CustomSampler.Begin, Sampler.Get.