Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

BeginSample(nint)

Starts profiling a piece of code marked with a custom name that the markerPtr handle has defined.
Read time 1 minuteLast updated 13 days ago

Definition

BeginSample(IntPtr)

public static void BeginSample(nint markerPtr)

Parameters

markerPtr

IntPtr
Profiler marker handle.

Remarks

Code marked with ProfilerUnsafeUtility.BeginSample and ProfilerUnsafeUtility.EndSample shows up in the Profiler hierarchy. Always use ProfilerUnsafeUtility.EndSample to close a started section of the instrumented code.
Note: Both ProfilerUnsafeUtility.BeginSample and ProfilerUnsafeUtility.EndSample are thread safe and can be used in jobified code.
The low level Profiler API is included in a Release Build.
using Unity.Collections.LowLevel.Unsafe;using Unity.Profiling.LowLevel;using Unity.Profiling.LowLevel.Unsafe;using System;class Example{    static readonly IntPtr markerHandle = ProfilerUnsafeUtility.CreateMarker("MyMarker", ProfilerUnsafeUtility.CategoryScripts, MarkerFlags.Default, 0);    static unsafe void DoWork(int num)    {        ProfilerUnsafeUtility.BeginSample(markerHandle);        //...        ProfilerUnsafeUtility.EndSample(markerHandle);    }}
Use Recorder to obtain per-frame timings in the Player for the specific marker name.
Additional Resources: ProfilerUnsafeUtility.CreateMarker, ProfilerUnsafeUtility.EndSample.