ProfilerUnsafeUtility
Utility class which provides access to low level Profiler API.
Read time 2 minutesLast updated 11 days ago
Definition
- Type: Class
- Namespace: Unity.Profiling.LowLevel.Unsafe
- Assembly: UnityEngine.CoreModule
public static class ProfilerUnsafeUtility
Remarks
Use ProfilerUnsafeUtility methods to build a high-level profiling primitive.
The low level Profiler API is included in a Release Build.
Static Fields
Value | Description |
|---|---|
| CategoryAi | AI and NavMesh Profiler category. |
| CategoryAllocation | Memory allocation Profiler category. |
| CategoryAnimation | Animation Profiler category. |
| CategoryAudio | Audio system Profiler category. |
| CategoryFileIO | File IO Profiler category. |
| CategoryGUI | UI Profiler category. |
| CategoryInput | Input system Profiler category. |
| CategoryInternal | Internal Unity systems Profiler category. |
| CategoryLighting | Global Illumination Profiler category. |
| CategoryLoading | Loading system Profiler category. |
| CategoryNetwork | Networking system Profiler category. |
| CategoryOther | Uncategorized Profiler category. |
| CategoryParticles | Particle system Profiler category. |
| CategoryPhysics | Physics system Profiler category. |
| CategoryPhysics2D | Physics 2D system Profiler category. |
| CategoryRender | Rendering system Profiler category. |
| CategoryScripts | Generic C# code Profiler category. |
| CategoryU2D | 2D Profiler category. |
| CategoryUIToolkit | UI Toolkit Profiler category. |
| CategoryVideo | Video system Profiler category. |
| CategoryVirtualTexturing | Virtual Texturing system Profiler category. |
| CategoryVr | VR systen Profiler category. |
Static Properties
Property | Description |
|---|---|
| Timestamp | Gets Profiler timestamp. |
| TimestampToNanosecondsConversionRatio | Gets conversion ratio from Profiler timestamp to nanoseconds. |
Static Methods
Method | Description |
|---|---|
| BeginSample | Starts profiling a piece of code marked with a custom name that the markerPtr handle has defined. |
| BeginSampleWithMetadata | Starts profiling a piece of code marked with a custom name that the markerPtr handle and metadata parameters has defined. |
| CreateFlow | Create a new Profiler flow identifier. |
| CreateMarker | Constructs a new Profiler marker handle for code instrumentation. |
| EndSample | End profiling a piece of code marked with a custom name defined by this instance of ProfilerMarker. |
| FlowEvent | Add flow event to a Profiler sample. |
| GetCategoryByName | Gets the Profiler category identifier. |
| GetCategoryDescription | Retrieves Profiler category information such as name or color. |
| SetMarkerMetadata | Set Profiler marker metadata name and type. |
| SingleSampleWithMetadata | Creates profiling sample with a custom name that the markerPtr handle and metadata parameters has defined. |
Structs
Struct | Description |
|---|---|
| ProfilerUnsafeUtility.TimestampConversionRatio | Fraction that converts the Profiler timestamp to nanoseconds. |