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

Namespace Unity.Simulation

Classes

AggregationEvent

Event class which contains the aggregated data.

ArrayUtilities

Utility class for converting Array types from one type to another without copying.

AsyncRequest

Base class for representing an asynchronous request. AsyncRequest is a bit like Task, but doesn't always execute on the main thread like Task in Unity. Another difference, is that several different lambda functors can operate on different parts of the data in parallel. Once all lambda functors have completed, the request is marked as complete.

AsyncRequest<T>

Concrete AsyncRequest for specific type T.

BaseDataConsumer<T>

Base class for data consumers to inherit from.

BaseDataConsumer<T>.Uploadable

ChunkedStream

Represents a stream that will flush after a certain size or time threshold.

ChunkedUnityLog

Unity log handler that dispatches in chunks.

CollectorBase

CollectorElement

CollectorsBaseEditor

CollectorsList

Configuration

Configuration class for application. Access to app params and other simulation configuration data.

ContentType

Utility class for converting a path to content-type.

ContinuousEvents

Continuous Events class for creating and updating events that measure some metric at a frequency and aggregate over a period.

CoreProfilerUtils

CounterEvent

DXChunkedStream

Represents a stream that will flush after a certain size or time threshold.

DXChunkedUnityLog

Unity log handler that dispatches in chunks.

DXFile

File write utility class that reports data written to the manager for uploading.

DXFormat

Format utility class for floats that truncates string representation to a certain precision for logging.

DXManager

The primary manager class for the SDK. Responsible for tracking data produced, uploading it, and waiting for it to complete.

DXTimeLogger

Tracks simulation and wall time, and periodically outputs to log.

DirectoryNameComponent

NameComponent that produces the directory path for the path.

EventBase

ExecUtility

ExitPlaymode

Utility class that shuts down the SDK when exiting playmode.

ExtensionNameComponent

NameComponent that produces the file extension for the path.

FileNameComponent

NameComponent that produces the filename (without the extension) for the path.

FileProducer

File write utility class that reports data written to the manager for uploading.

Format

Format utility class for floats that truncates string representation to a certain precision for logging.

FrameCountCondition

Condition object to evaluate if a specific number of frames since object instantiation have elapsed.

FrameLimit

FrameNumberNameComponent

NameComponent that adds the current frame number to the path.

IgnoreCollectorAttribute

LabelNameComponent

NameComponent that applies a label to the path.

Log

Logging class that the SDK uses for logging. Essentially a wrapper around Debug.Log/Console.WriteLine.

Manager

The primary manager class for the SDK. Responsible for tracking data produced, uploading it, and waiting for it to complete.

NameComponent

Base class for all NameComponent classes. To create your own NameComponent derive from this an implement the needed virtual methods.

NameGenerator

Name Generator class. These can be created and configured in the editor. Certain components use these, and they can be assigned in the inspector.

Options

Various options that can be configured for the Core package.

PackageImportTests

PathUtility

PerfStatsManager

PlayerResolutionSettings

ProfilerManager

Utility class to enable profiling for the application.

ProfilerProperties

ProfilerReport

ProfilerSamplingEvent

Event for sampling a piece of the code

ReportingUtils

Sample

SampleProfilerCollector

SequenceNameComponent

NameComponent that adds a sequence number to the path.

SignedURLDataConsumer

Cloud agnostic consumer for uploading data.

SimSecondsCondition

Condition object to evaluate if a specific number of simulation seconds (scaled) since object instantiation have elapsed.

SimulationProfiler

SimulationProfilerBase

SimulationProfilerEditor

TestUtility

Utility class that determines if the app is running under the Test Runner.

ThreadUtility

Utility class that determines if you are running on the main thread or not.

TimeLimit

Component for limiting the simulation based on time. Add this component to a GameObject and set the time in seconds for how long you want the simulation to run.

TimeLogger

Tracks simulation and wall time, and periodically outputs to log.

TimeScale

TimeScaleEditor

TimeUtility

Timer

Timer class for abstracting elapsed time from various sources.

TimestampNameComponent

NameComponent that adds a UTC timestamp to the path.

WallSecondsCondition

Condition object to evaluate if a specific number of wall seconds since object instantiation have elapsed.

Structs

AggregatedSample

ArrayCast

Union class for converting Array types from one type to another without copying.

Configuration.SimulationConfiguration

CounterEventData

Structure to hold counter event data.

DataCapturePaths

DataCapture path constants.

LambdaJob

PlayerResolution

SequencedPathName

Utility class to generate filenames with a sequence number.

Interfaces

ICondition

Interface for defining a specific condition to check for.

IDataProduced

Interface for consuming data. Consumers must implement this, and return true from Initialize if the consumer is able/desired to operate.

IGlobalProfilerDataDispatcher

Enums

AsyncRequest.ExecutionContext

An enum describing execution context for lambda functors that need to be invoked.

AsyncRequest.Result

An enum describing the result status.

AsyncRequest.State

Flags for the _state field which holds whether or not the request has started and or has an error.

Category

Profiler category under which the collector data needs to be displayed.

Dispatcher

Log.Level

An enum describing different logging levels.

TimerSource

Enumeration for the various supported timer sources.

Delegates

CollectorBase.ConsumeCollectorReport

Consumer delegate to consume the collector profiler report.

ContinuousEvents.EventCollectionDelegate

Delegate for collecting some metric.

ContinuousEvents.EventDispatchDelegate

Dispatch delegate for consuming aggregated event data.

LambdaJob.DelegateType

Manager.NotificationDelegate

Delegate declaration for notifications.

Manager.TickDelegate

Delegate declaration for per frame ticks.

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