docs.unity3d.com
    Show / Hide Table of Contents

    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

    BaseLogger

    CameraGrab

    CaptureCamera

    Capture class for cameras. Supports Color, Depth, MotionVectors. Captures supported channels to file system and notifies Manager.

    CaptureGPUBuffer

    CaptureImageEncoder

    CaptureOptions

    Class with some options that can be changed at runtime.

    CaptureRenderTexture

    Capture class for capturing RenderTexture contents.

    ChannelGrab

    ChunkedStream

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

    CollectorBase

    CollectorElement

    CollectorsBaseEditor

    CollectorsList

    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

    DepthGrab

    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.

    EventBase

    ExecUtility

    ExitPlaymode

    Utility class that shuts down the SDK when exiting playmode.

    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

    GeneralUtilities

    GraphicsUtilities

    IgnoreCollectorAttribute

    Log

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

    Logger

    Manager

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

    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

    ScreenCapture

    SimSecondsCondition

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

    SimulationProfiler

    SimulationProfilerBase

    SRPSupport

    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.

    Timer

    Timer class for abstracting elapsed time from various sources.

    TimeScale

    TimeUtility

    UnityVersion

    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.

    CaptureCamera.CaptureState

    Capture state when asynchronously capturing a camera render.

    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.

    CaptureCamera.Channel

    Enumeration for the supported channels.

    CaptureImageEncoder.ImageFormat

    An enum describing the image format

    Category

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

    Dispatcher

    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

    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

    Manager.NotificationDelegate

    Delegate declaration for notifications.

    Manager.TickDelegate

    Delegate declaration for per frame ticks.

    RenderPassCallbackDelegate

    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