docs.unity3d.com
  • Manual
  • Scripting API
  • Changelog
  • License
Show / Hide Table of Contents
    • AddCollectorMenuAttribute
  • Unity.Simulation
    • AggregatedSample
    • AggregationEvent
    • ArrayCast
    • ArrayUtilities
    • AsyncRequest
    • AsyncRequest.ExecutionContext
    • AsyncRequest.Result
    • AsyncRequest.State
    • AsyncRequest<T>
    • BaseDataConsumer<T>
    • BaseDataConsumer<T>.Uploadable
    • Category
    • ChunkedStream
    • ChunkedUnityLog
    • CollectorBase
    • CollectorBase.ConsumeCollectorReport
    • CollectorElement
    • CollectorsBaseEditor
    • CollectorsList
    • Configuration
    • Configuration.SimulationConfiguration
    • ContentType
    • ContinuousEvents
    • ContinuousEvents.EventCollectionDelegate
    • ContinuousEvents.EventDispatchDelegate
    • CoreProfilerUtils
    • CounterEvent
    • CounterEventData
    • DXChunkedStream
    • DXChunkedUnityLog
    • DXFile
    • DXFormat
    • DXManager
    • DXTimeLogger
    • DataCapturePaths
    • DirectoryNameComponent
    • Dispatcher
    • EventBase
    • ExecUtility
    • ExitPlaymode
    • ExtensionNameComponent
    • FileNameComponent
    • FileProducer
    • Format
    • FrameCountCondition
    • FrameLimit
    • FrameNumberNameComponent
    • ICondition
    • IDataProduced
    • IGlobalProfilerDataDispatcher
    • IgnoreCollectorAttribute
    • LabelNameComponent
    • LambdaJob
    • LambdaJob.DelegateType
    • Log
    • Log.Level
    • Manager
    • Manager.NotificationDelegate
    • Manager.TickDelegate
    • NameComponent
    • NameGenerator
    • Options
    • PackageImportTests
    • PathUtility
    • PerfStatsManager
    • PlayerResolution
    • PlayerResolutionSettings
    • ProfilerManager
    • ProfilerProperties
    • ProfilerReport
    • ProfilerSamplingEvent
    • ReportingUtils
    • Sample
    • SampleProfilerCollector
    • SequenceNameComponent
    • SequencedPathName
    • SignedURLDataConsumer
    • SimSecondsCondition
    • SimulationProfiler
    • SimulationProfilerBase
    • SimulationProfilerEditor
    • TestUtility
    • ThreadUtility
    • TimeLimit
    • TimeLogger
    • TimeScale
    • TimeScaleEditor
    • TimeUtility
    • Timer
    • TimerSource
    • TimestampNameComponent
    • WallSecondsCondition

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(float)
EventBase._elapsedInterval
EventBase._elapsedPeriod
EventBase._interval
EventBase._period
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Unity.Simulation
Assembly: Unity.Simulation.Core.dll
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.

In This Article
Back to top
Copyright © 2026 Unity Technologies — Trademarks and terms of use
  • Legal
  • Privacy Policy
  • Cookie Policy
  • Do Not Sell or Share My Personal Information