Begin
Begin profiling a piece of code with a custom label defined by this instance of CustomSampler.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine.Profiling
- Assembly: UnityEngine.CoreModule
Begin()
Begin profiling a piece of code with a custom label defined by this instance of CustomSampler.
[Conditional("ENABLE_PROFILER")]public void Begin()
Remarks
This will show up in the Profiler hierarchy.
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(); }}
Profiler.BeginSample is conditionally compiled away using ConditionalAttribute. Thus it will have zero overhead, when it is deployed in non-Development Build.
Begin(Object)
Begin profiling a piece of code with a custom label defined by this instance of CustomSampler.
[Conditional("ENABLE_PROFILER")]public void Begin(Object targetObject)
Parameters
Remarks
This will show up in the Profiler hierarchy.
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(); }}
Profiler.BeginSample is conditionally compiled away using ConditionalAttribute. Thus it will have zero overhead, when it is deployed in non-Development Build.