docs.unity3d.com
    Show / Hide Table of Contents

    Class CounterConfiguration

    Counter configuration used by DisplayElementConfiguration. This configuration contain all information about a counter.

    Inheritance
    Object
    CounterConfiguration
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Multiplayer.Tools.NetStatsMonitor
    Syntax
    [Serializable]
    public sealed class CounterConfiguration

    Properties

    AggregationMethod

    The desired aggregation method for the stats used in the counter.

    Declaration
    public AggregationMethod AggregationMethod { get; set; }
    Property Value
    Type Description
    AggregationMethod

    ExponentialMovingAverageParams

    Parameters used if SmoothingMethod is set to ExponentialMovingAverage.

    Declaration
    public ExponentialMovingAverageParams ExponentialMovingAverageParams { get; set; }
    Property Value
    Type Description
    ExponentialMovingAverageParams

    HighlightLowerBound

    Values below this threshold will be highlighted by the default styling, and can be highlighted by custom styling using the following USS classes:

    • rnsm-counter-out-of-bounds
    • rnsm-counter-below-threshold
    Declaration
    public float HighlightLowerBound { get; set; }
    Property Value
    Type Description
    Single

    HighlightUpperBound

    Values above this threshold will be highlighted by the default styling, and can be highlighted by custom styling using the following USS classes:

    • rnsm-counter-out-of-bounds
    • rnsm-counter-above-threshold
    Declaration
    public float HighlightUpperBound { get; set; }
    Property Value
    Type Description
    Single

    SampleCount

    The current configured sample count. Note that if the SmoothingMethod is set to ExponentialMovingAverage, the sample count will be zero.

    Declaration
    public int SampleCount { get; }
    Property Value
    Type Description
    Int32

    SignificantDigits

    The number of significant digits to display for this counter.

    Declaration
    public int SignificantDigits { get; set; }
    Property Value
    Type Description
    Int32

    SimpleMovingAverageParams

    Parameters used if SmoothingMethod is set to SimpleMovingAverage.

    Declaration
    public SimpleMovingAverageParams SimpleMovingAverageParams { get; set; }
    Property Value
    Type Description
    SimpleMovingAverageParams

    SmoothingMethod

    The desired smoothing method over time for the counter.

    Declaration
    public SmoothingMethod SmoothingMethod { get; set; }
    Property Value
    Type Description
    SmoothingMethod
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on 26 October 2023