Class ProfilerMode

Base class for all profiler modes. Implementation collects profiling events and presents it using dedicated UI.

System.Object
Control
ContainerControl
FlaxEditor.GUI.Tabs.Tab
ProfilerMode
System.IComparable
Namespace: FlaxEditor.Windows.Profiler
Assembly: FlaxEngine.CSharp.dll
Syntax
public class ProfilerMode : Tab, IComparable, IDrawable

Constructors

ProfilerMode(String)

Declaration
public ProfilerMode(string text)
Parameters
System.String text

Fields

MaxSamples

The maximum amount of samples to collect.

Declaration
public const int MaxSamples = 600
Field Value
System.Int32

MinEventTimeMs

The minimum event time in ms.

Declaration
public const double MinEventTimeMs = 1E-09
Field Value
System.Double

Methods

Clear()

Clears this instance.

Declaration
public virtual void Clear()

Init()

Initializes this instance.

Declaration
public virtual void Init()

OnDestroy()

Declaration
public override void OnDestroy()
Overrides
FlaxEditor.GUI.Tabs.Tab.OnDestroy()

OnSelectedSampleChanged(Int32)

Called when selected sample gets changed.

Declaration
protected virtual void OnSelectedSampleChanged(int frameIndex)
Parameters
System.Int32 frameIndex

Index of the view frame.

RecycleTableRows(Table, List<Row>)

Recycles all table rows to be reused.

Declaration
protected static void RecycleTableRows(Table table, List<Row> rowsCache)
Parameters
Table table

The table.
System.Collections.Generic.List<Row> rowsCache

The output cache.

Update(ref ProfilerMode.SharedUpdateData)

Updates this instance. Called every frame if live recording is enabled.

Declaration
public virtual void Update(ref ProfilerMode.SharedUpdateData sharedData)
Parameters
ProfilerMode.SharedUpdateData sharedData

The shared data.

UpdateStats()

Tick called before updating any modes display. Can be used to update per-frame statistics data.

Declaration
public virtual void UpdateStats()

UpdateView(Int32, Boolean)

Updates the mode view. Called after init and on selected frame changed.

Declaration
public virtual void UpdateView(int selectedFrame, bool showOnlyLastUpdateEvents)
Parameters
System.Int32 selectedFrame

The selected frame index.
System.Boolean showOnlyLastUpdateEvents

True if show only events that happened during the last engine update (excluding events from fixed update or draw event), otherwise show all collected events.

Events

SelectedSampleChanged

Occurs when selected sample gets changed. Profiling window should propagate this change to all charts and view modes.

Declaration
public event Action<int> SelectedSampleChanged
Event Type
System.Action<System.Int32>

Extension Methods