docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct InputMetrics

    Provides information on the level of throughput going through the system.

    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Namespace: UnityEngine.InputSystem.LowLevel
    Assembly: Unity.InputSystem.dll
    Syntax
    [Serializable]
    public struct InputMetrics

    Properties

    averageEventBytesPerFrame

    Average size of the event buffer received on every Update().

    Declaration
    public float averageEventBytesPerFrame { get; }
    Property Value
    Type Description
    float
    See Also
    metrics

    averageLagTimePerEvent

    Average time it takes from when an event is generated to when it is processed.

    Declaration
    public double averageLagTimePerEvent { get; }
    Property Value
    Type Description
    double
    See Also
    totalEventLagTime

    averageProcessingTimePerEvent

    Average time in seconds spend on processing each individual InputEvent.

    Declaration
    public double averageProcessingTimePerEvent { get; }
    Property Value
    Type Description
    double
    See Also
    metrics

    currentControlCount

    Total number of InputControls currently alive in devices in the system.

    Declaration
    public int currentControlCount { readonly get; set; }
    Property Value
    Type Description
    int
    See Also
    metrics

    currentLayoutCount

    Total number of currently registered layouts.

    Declaration
    public int currentLayoutCount { readonly get; set; }
    Property Value
    Type Description
    int
    See Also
    metrics

    currentNumDevices

    Number of devices currently added to the system.

    Declaration
    public int currentNumDevices { readonly get; set; }
    Property Value
    Type Description
    int
    See Also
    devices

    currentStateSizeInBytes

    Total size of the combined state memory for all current devices.

    Declaration
    public int currentStateSizeInBytes { readonly get; set; }
    Property Value
    Type Description
    int
    See Also
    metrics

    maxNumDevices

    Maximum number of devices that were concurrently added to the system.

    Declaration
    public int maxNumDevices { readonly get; set; }
    Property Value
    Type Description
    int
    See Also
    devices

    maxStateSizeInBytes

    The largest the combined state memory for all devices got.

    Declaration
    public int maxStateSizeInBytes { readonly get; set; }
    Property Value
    Type Description
    int
    See Also
    metrics

    totalEventBytes

    Total number of bytes of InputEvents consumed so far.

    Declaration
    public int totalEventBytes { readonly get; set; }
    Property Value
    Type Description
    int
    See Also
    metrics

    totalEventCount

    Total number of InputEvents consumed so far.

    Declaration
    public int totalEventCount { readonly get; set; }
    Property Value
    Type Description
    int
    See Also
    metrics

    totalEventLagTime

    Total accumulated time that has passed between when events were generated (see time) compared to when they were processed.

    Declaration
    public double totalEventLagTime { readonly get; set; }
    Property Value
    Type Description
    double
    See Also
    metrics

    totalEventProcessingTime

    Total time in seconds spent processing InputEvents so far.

    Declaration
    public double totalEventProcessingTime { readonly get; set; }
    Property Value
    Type Description
    double
    Remarks

    Event processing usually amounts for the majority of time spent in Update() but not necessarily for all of it.

    See Also
    Update()

    totalUpdateCount

    Total number of input system updates run so far.

    Declaration
    public int totalUpdateCount { readonly get; set; }
    Property Value
    Type Description
    int
    See Also
    Update()

    See Also

    metrics
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)