docs.unity3d.com
    Show / Hide Table of Contents

    Class PerfStatsManager

    Inheritance
    Object
    PerfStatsManager
    Namespace: Unity.Simulation
    Syntax
    public class PerfStatsManager

    Fields

    DEFAULT_ERROR_SAMPLE_VALUE

    Declaration
    public double DEFAULT_ERROR_SAMPLE_VALUE
    Field Value
    Type Description
    Double

    realTimeSinceStartUp

    Declaration
    public float realTimeSinceStartUp
    Field Value
    Type Description
    Single

    Properties

    Instance

    PerfStatsManager singleton instance to that can enable Start/Stop invoking the collectors.

    Declaration
    public static PerfStatsManager Instance { get; }
    Property Value
    Type Description
    PerfStatsManager

    Methods

    BeginSample(String, Type)

    Begin sample for the provided event.

    Declaration
    public void BeginSample(string eventName, Type associatedCollectorType)
    Parameters
    Type Name Description
    String eventName
    Type associatedCollectorType

    DispatchCollectors(Boolean)

    Invoke this function to flush all the events on all the collectors. This will invoke dispatcher on all the collectors. This call can be slow depending upon the dispatcher implementation.

    Declaration
    public void DispatchCollectors(bool shuttingDown = false)
    Parameters
    Type Name Description
    Boolean shuttingDown

    EndSample(String, Type)

    End Sample for the provided event.

    Declaration
    public void EndSample(string eventName, Type associatedCollectorType)
    Parameters
    Type Name Description
    String eventName
    Type associatedCollectorType

    SetGlobalDispatchers(List<IGlobalProfilerDataDispatcher>)

    Declaration
    public void SetGlobalDispatchers(List<IGlobalProfilerDataDispatcher> dispatchers)
    Parameters
    Type Name Description
    List<IGlobalProfilerDataDispatcher> dispatchers

    StartProfiling(List<CollectorBase>)

    Invoke this method to start profiling by invoking/activating collectors.

    Declaration
    public void StartProfiling(List<CollectorBase> collectors)
    Parameters
    Type Name Description
    List<CollectorBase> collectors

    StopProfiling()

    Inovke this method to stop profiling.

    Declaration
    public void StopProfiling()

    TrackAPIUsage(String, Type)

    Track API usage for the provided function.

    Declaration
    public void TrackAPIUsage(string functionName, Type associatedColletorType)
    Parameters
    Type Name Description
    String functionName
    Type associatedColletorType
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023