ISession

Namespace: WellFired

Description

Implement this interface if you’d like to create an object that tracks probes.

Public Methods

void StartRecording ( )
void StopRecording ( )
void Track ( IProbe probe, RecordMode recordMode = RecordMode.Continous, int interval = 0 )
void Track ( Func< object > method, RecordMode recordMode = RecordMode.Continous, int interval = 0 )
void Track ( IEnumerable< DefaultProbe > probes )
void ProcessData ( IProfileProcessor processor )

Breakdown

  • void StartRecording ( )

    Description

    Will start this profilers recording session. What is tracked and how it is process should be specify beforehand

  • void StopRecording ( )

    Description

    Will Stop this profilers recording session.

  • void Track ( IProbe probe, RecordMode recordMode = RecordMode.Continous, int interval = 0 )

    Description

    Call this to specify the probes you want to use to track data. You can add custom probes here, or any of the many pre-created probes. You can record probes continuously or only once when the session is just started (one-shot mode). If you just want an easy to use interface, you can prefer the to use Track(IEnumerable probes)

    Parameters

    probe Here you can pass any probes you want to track.
    recordMode Continous or One-Shot recording
    interval Time interval between each data sampling. Note that the time used is based on the system clock, therefore it is independent from the game time scale

  • void Track ( Func< object > method, RecordMode recordMode = RecordMode.Continous, int interval = 0 )

    Description

    Call this to track the data returned by one of your method.

    Parameters

    method
    recordMode
    interval

  • void Track ( IEnumerable< DefaultProbe > probes )

    Description

    This method works similar to the Track method but record mode and interval are specified by default in the Default Probes. You can pass one of the groups of default probes we already provide, like Defaults.All. You should prefer this method if you don’t need 100% control over your probes.

    Parameters

    probes You can also pass one of the provided utilities like Defaults.All

  • void ProcessData ( IProfileProcessor processor )

    Description

    How do you want to process the data. We provide many default processors including the VisualProcessor, which will display data to the screen

    Parameters

    processor