Namespace Unity.SimulationPro
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
Uploadable.
BaseLogger
Abstract base class that manages output path construction and sequenced file naming for loggers and screen-capture helpers.
BatchReadback
Batches GPU texture readback requests and flushes them in groups to reduce per-frame overhead.
CameraGrab
A convenience MonoBehaviour that periodically captures color images from one or more cameras and writes them to the file system at a configurable interval.
CaptureCamera
Capture class for cameras. Supports Color, Depth, MotionVectors. Captures supported channels to file system and notifies Manager.
CaptureGPUBuffer
Provides static helper methods for performing asynchronous GPU readback from ComputeBuffer and Texture sources. Falls back to synchronous readback when async GPU readback is unavailable on the current platform.
CaptureImageEncoder
Provides methods for encoding raw texture data to common image formats such as PNG, JPG, EXR, TGA, and raw bytes.
CaptureOptions
Class with some options that can be changed at runtime.
CaptureRenderTexture
Capture class for capturing RenderTexture contents.
ChannelGrab
A convenience MonoBehaviour that captures a single camera channel (color, depth, normal, or motion) at a regular interval and writes encoded images to the file system.
ChunkedStream
Represents a stream that will flush after a certain size or time threshold.
CollectorBase
Abstract base class for simulation profiler collectors that gather performance and diagnostic data and dispatch it (by default as JSON) to the local file system.
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.
CounterEvent
An EventBase that tracks discrete call counts per named function over time.
DXChunkedStream
Represents a stream that will flush after a certain size or time threshold.
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.
DepthGrab
A convenience MonoBehaviour that captures the depth channel of a camera at a regular interval and writes encoded images to the file system.
DirectoryNameComponent
NameComponent that produces the directory path for the path.
EventBase
Abstract base class for profiler events that collect and aggregate metrics over time.
ExecUtility
Utility class for executing shell commands synchronously and capturing their output.
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
A MonoBehaviour component that quits the simulation after a specified number of frames.
FrameNumberNameComponent
NameComponent that adds the current frame number to the path.
GeneralUtilities
General-purpose runtime utilities, including Unity version comparison helpers.
GraphicsUtilities
Provides GPU readback and graphics format helper methods used by the capture pipeline.
IgnoreCollectorAttribute
Marks a CollectorBase subclass so that it is excluded from automatic collector discovery and will not appear in the simulation profiler UI.
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.
Logger
A buffered text logger that serializes objects as JSON and writes them to disk via ChunkedStream.
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.
PathUtility
Helper utilities for normalizing and querying file-system paths.
PerfStatsManager
Singleton manager that drives all registered CollectorBase instances, ticking their events each frame and dispatching aggregated ProfilerReport objects on the configured period.
PlayerResolutionSettings
A ScriptableObject that configures the back-buffer resolution and optional target RenderTexture for headless (cloud rendering / Linux headless simulation) builds.
ProfilerManager
Utility class to enable profiling for the application.
ProfilerProperties
Configures fixed-update frequency and time-scale properties used by the simulation profiler.
ProfilerReport
A serializable snapshot of a collector's events produced at each dispatch interval.
ProfilerSamplingEvent
Event for sampling a piece of the code
ReadbackRequest
Holds the state for a single GPU texture readback operation managed by BatchReadback.
ReportingUtils
Utility class for assembling ProfilerReport instances from a list of events.
SRPSupport
Provides URP and HDRP integration for the camera capture subsystem. Manages custom render passes, depth buffer copies, and per-camera request queuing so that CaptureCamera works transparently across render pipelines.
Sample
Stores per-thread timing state for a named sample captured by ProfilerSamplingEvent.
SampleProfilerCollector
A sample CollectorBase that demonstrates registering a CounterEvent and a ProfilerSamplingEvent for basic API-usage and timing profiling.
ScreenCapture
A convenience wrapper around CaptureCamera that asynchronously captures a camera's color buffer and writes it to a sequenced file on disk.
SequenceNameComponent
NameComponent that adds a sequence number to the path.
SimSecondsCondition
Condition object to evaluate if a specific number of simulation seconds (scaled) since object instantiation have elapsed.
SimulationProfiler
The default concrete SimulationProfilerBase implementation that applies fixedUpdateFrequency and timeScale to Unity's time settings on startup.
SimulationProfilerBase
Abstract base MonoBehaviour for managing a collection of CollectorBase instances and driving simulation profiling.
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
A MonoBehaviour that dynamically scales timeScale to maximize simulation throughput while staying within a target CPU utilization budget.
TimeScaleEditor
TimeUtility
Provides Unix-epoch timestamp helpers.
Timer
Timer class for abstracting elapsed time from various sources.
TimestampNameComponent
NameComponent that adds a UTC timestamp to the path.
UnityVersion
Represents a Unity version number with major, minor, and patch components.
WallSecondsCondition
Condition object to evaluate if a specific number of wall seconds since object instantiation have elapsed.
Structs
AggregatedSample
Holds aggregated min, max, and average timing values across all samples for a named profiling key.
ArrayCast
Union class for converting Array types from one type to another without copying.
CaptureCamera.CaptureState
Capture state when asynchronously capturing a camera render.
CounterEventData
Holds the accumulated count and most recent timestamp for a single named function entry in a CounterEvent.
DataCapturePaths
DataCapture path constants.
LambdaJob
An Unity.Jobs.IJob implementation that executes an arbitrary delegate on a worker thread.
PlayerResolution
A width/height pair describing the target render resolution on headless player builds.
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
Defines a global dispatcher that receives aggregated profiler reports from all active collectors. Implement this interface to route profiler data to custom sinks (e.g. remote telemetry, UI).
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.
CaptureCamera.Channel
Enumeration for the supported channels.
CaptureImageEncoder.ImageFormat
Specifies the output image file format used when encoding captured texture data.
Category
Profiler category under which the collector data needs to be displayed.
Dispatcher
Selects the dispatch strategy used to route profiler reports.
ForceFlip
Enum for overriding the internal check to determine if the image should be flipped. Can be used on a per channel basis, or for all channels.
Log.Level
An enum describing different logging levels.
LoggerSuffixOption
Controls how the file-name suffix is generated for each log or capture output.
RenderingPipelineType
An enum indicating the type of rendering pipeline being used.
TimerSource
Enumeration for the various supported timer sources.
Delegates
CaptureCamera.ReadbackCompletionDelegate
Invoked when a request has completed reading back data for a channel.
CaptureCamera.RequestCompletionDelegate
Invoked when a request has completed readback of all channels.
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
The delegate type accepted by LambdaJob.
Manager.NotificationDelegate
Delegate declaration for notifications.
Manager.TickDelegate
Delegate declaration for per frame ticks.
RenderPassCallbackDelegate
Callback invoked by the SRP capture pipeline at the end of camera rendering.