docs.unity3d.com
    Show / Hide Table of Contents

    Class ProfilerSamplingEvent

    Event for sampling a piece of the code

    Inheritance
    Object
    EventBase
    ProfilerSamplingEvent
    Inherited Members
    EventBase.dispatchDelegate
    EventBase.collector
    EventBase.eventName
    EventBase.allowMultipledEventsOfType
    EventBase.resetOnEachSampleCollection
    EventBase.IsMultipleEventsInstancesAllowed()
    EventBase.Reset()
    EventBase.IngestValue(Double)
    EventBase.Update(Single)
    EventBase._elapsedInterval
    EventBase._elapsedPeriod
    EventBase._interval
    EventBase._period
    Namespace: Unity.Simulation
    Syntax
    public class ProfilerSamplingEvent : EventBase

    Constructors

    ProfilerSamplingEvent(String)

    Declaration
    public ProfilerSamplingEvent(string eventName)
    Parameters
    Type Name Description
    String eventName

    Fields

    AggregatedSamples

    Declaration
    public Dictionary<string, AggregatedSample> AggregatedSamples
    Field Value
    Type Description
    Dictionary<String, AggregatedSample>

    Methods

    BeginSample(String)

    Start sampling. This start the stopwatch for the provided sample name.

    Declaration
    public void BeginSample(string key)
    Parameters
    Type Name Description
    String key

    Name of the sample that is uniquely identifiable in the associated collector.

    EndSample(String)

    End sample. This stops the stopwatch for provided sample name and captures the elasped time.

    Declaration
    public void EndSample(string key)
    Parameters
    Type Name Description
    String key

    Name of the sample used to begin sample.

    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