Class TraceFile

Definition

Namespace: StardewUI.Framework.Diagnostics
Assembly: StardewUI.dll

Format of a trace file compatible with speedscope.

public class TraceFile

Inheritance
Object ⇦ TraceFile

Name	Description
TraceFile()

Name	Description
CreationDate	Exact date and time when the trace was started.
Exporter	The name and version of the exporting mod (i.e. StardewUI).
Profiles	List of profiles; each profile corresponds to a running thread.
SchemaUrl	JSON schema URL; required by the Speedscope web tool.
Shared	Shared trace data, containing the frames or slice names.

Name	Description
CloseFrame(Int32)	Appends an event that closes a frame previously opened with OpenFrame(string).
OpenFrame(string)	Adds a new TraceFrame and TraceEvent to open it, and returns the frame index to be used subsequently with CloseFrame(Int32).

public TraceFile();

Exact date and time when the trace was started.

public System.DateTime CreationDate { get; }

The name and version of the exporting mod (i.e. StardewUI).

public string Exporter { get; set; }

List of profiles; each profile corresponds to a running thread.

public System.Collections.Generic.List<StardewUI.Framework.Diagnostics.TraceProfile> Profiles { get; }

JSON schema URL; required by the Speedscope web tool.

public string SchemaUrl { get; }

Shared trace data, containing the frames or slice names.

public StardewUI.Framework.Diagnostics.TraceShared Shared { get; }

Appends an event that closes a frame previously opened with OpenFrame(string).

public void CloseFrame(int frame);

frame Int32
The index of the tracked frame in Frames.

Adds a new TraceFrame and TraceEvent to open it, and returns the frame index to be used subsequently with CloseFrame(Int32).

public int OpenFrame(string name);

name string
Name of the method or operation being traced.

The frame index, to be used with CloseFrame(Int32) when the operation completes.