Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SingleSampleWithMetadata(nint, int, void*)

Creates profiling sample with a custom name that the markerPtr handle and metadata parameters has defined.
Read time 1 minuteLast updated 12 days ago

Definition

SingleSampleWithMetadata(IntPtr, int, void*)

public static void SingleSampleWithMetadata(nint markerPtr, int metadataCount, void* metadata)

Parameters

markerPtr

IntPtr
Profiler marker handle.

metadataCount

int
Metadata parameters count.

metadata

void*
Unsafe pointer to the ProfilerMarkerData array.

Remarks

Sample created with ProfilerUnsafeUtility.SingleSampleWithMetadata shows up as a sample with zero duration in the Profiler hierarchy. In the Timeline view of the Profiler Window the provided metadata is available in the tooltip message. Use HierarchyFrameDataView.GetItemMetadata to retrieve metadata programmatically.
If markerPtr points to a marker with MarkerFlags.Counter defined, the metadata value can be retrieved with FrameDataView.GetCounterValueAsInt methods.
Note: ProfilerUnsafeUtility.SingleSampleWithMetadata is thread safe and can be used in jobified code.
The low level Profiler API is included in a Release Build.