Class Profiling

A set of functionality useful for creating profiling data to reason about the performance of an application.

Inheritance

System.Object

Profiling

Namespace: GDX.Developer

Syntax

public class Profiling

Methods

StartProfiling(String, Boolean)

Setup a profiling session used during an import. This will create a binary file when finished profiling.

Declaration

public static void StartProfiling(string prefix = null, bool manageProfiles = true)

Parameters

Type	Name	Description
System.String	prefix	Optional descriptor for profile run used in filename.
System.Boolean	manageProfiles	Should the number of profiles be managed.

Exceptions

Type	Condition
UnsupportedRuntimeException	Not supported on DOTS Runtime.

StopProfiling()

Finalize a profiling session during an import.

Declaration

public static void StopProfiling()

Exceptions

Type	Condition
UnsupportedRuntimeException	Not supported on DOTS Runtime.

TakeMemorySnapshot(String, Action<String, Boolean>, CaptureFlags, Boolean)

Take a memory snapshot and save it to GetOutputFolder(String).

Declaration

public static void TakeMemorySnapshot(string prefix = null, Action<string, bool> finishCallback = null, CaptureFlags captureFlags = CaptureFlags.ManagedObjects | CaptureFlags.NativeObjects | CaptureFlags.NativeAllocations | CaptureFlags.NativeAllocationSites | CaptureFlags.NativeStackTraces, bool manageCaptures = true)

Parameters

Type	Name	Description
System.String	prefix	Override the default prefix GDX.Developer.Profiling.k_MemoryCaptureFilePrefix.
System.Action<System.String, System.Boolean>	finishCallback	Optional callback action once the memory capture has been made.
UnityEngine.Profiling.Memory.Experimental.CaptureFlags	captureFlags	Override of the memory capture flags, defaults to GDX.Developer.Profiling.k_AllCaptureFlags.
System.Boolean	manageCaptures	Should the number of captures found in the output folder be managed?

Exceptions

Type	Condition
UnsupportedRuntimeException	Not supported on DOTS Runtime.