Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

CustomSampler.Create

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

Submission failed

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

Close

Cancel

public static method Create(name: string): Profiling.CustomSampler;
public static Profiling.CustomSampler Create(string name);

Parameters

name Name of the Sampler.

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.

#pragma strict
var sampler: CustomSampler;
function Start() {
	sampler = CustomSampler.Create("MyCustomSampler");
}
function Update() {
	sampler.Begin();
	// do something that takes a lot of time
	sampler.End();
}
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(); } }

Did you find this page useful? Please give it a rating: