Class MethodMeasurement | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class MethodMeasurement

    Inheritance
    System.Object
    MethodMeasurement
    Namespace: Unity.PerformanceTesting.Measurements
    Syntax
    public class MethodMeasurement

    Constructors

    MethodMeasurement(Action)

    Declaration
    public MethodMeasurement(Action action)
    Parameters
    Type Name Description
    System.Action action

    Methods

    CleanUp(Action)

    Declaration
    public MethodMeasurement CleanUp(Action action)
    Parameters
    Type Name Description
    System.Action action
    Returns
    Type Description
    MethodMeasurement

    Definition(String, SampleUnit, AggregationType, Double, Boolean, Boolean)

    Declaration
    public MethodMeasurement Definition(string name = "Totaltime", SampleUnit sampleUnit = SampleUnit.Millisecond, AggregationType aggregationType = AggregationType.Median, double threshold = 0.1, bool increaseIsBetter = false, bool failOnBaseline = true)
    Parameters
    Type Name Description
    System.String name
    SampleUnit sampleUnit
    AggregationType aggregationType
    System.Double threshold
    System.Boolean increaseIsBetter
    System.Boolean failOnBaseline
    Returns
    Type Description
    MethodMeasurement

    Definition(String, SampleUnit, AggregationType, Double, Double, Boolean, Boolean)

    Declaration
    public MethodMeasurement Definition(string name, SampleUnit sampleUnit, AggregationType aggregationType, double percentile, double threshold = 0.1, bool increaseIsBetter = false, bool failOnBaseline = true)
    Parameters
    Type Name Description
    System.String name
    SampleUnit sampleUnit
    AggregationType aggregationType
    System.Double percentile
    System.Double threshold
    System.Boolean increaseIsBetter
    System.Boolean failOnBaseline
    Returns
    Type Description
    MethodMeasurement

    Definition(SampleGroupDefinition)

    Declaration
    public MethodMeasurement Definition(SampleGroupDefinition definition)
    Parameters
    Type Name Description
    SampleGroupDefinition definition
    Returns
    Type Description
    MethodMeasurement

    GC()

    Declaration
    public MethodMeasurement GC()
    Returns
    Type Description
    MethodMeasurement

    IterationsPerMeasurement(Int32)

    Declaration
    public MethodMeasurement IterationsPerMeasurement(int count)
    Parameters
    Type Name Description
    System.Int32 count
    Returns
    Type Description
    MethodMeasurement

    MeasurementCount(Int32)

    Declaration
    public MethodMeasurement MeasurementCount(int count)
    Parameters
    Type Name Description
    System.Int32 count
    Returns
    Type Description
    MethodMeasurement

    ProfilerMarkers(SampleGroupDefinition[])

    Declaration
    public MethodMeasurement ProfilerMarkers(params SampleGroupDefinition[] profilerDefinitions)
    Parameters
    Type Name Description
    SampleGroupDefinition[] profilerDefinitions
    Returns
    Type Description
    MethodMeasurement

    Run()

    Declaration
    public void Run()

    SetUp(Action)

    Declaration
    public MethodMeasurement SetUp(Action action)
    Parameters
    Type Name Description
    System.Action action
    Returns
    Type Description
    MethodMeasurement

    WarmupCount(Int32)

    Declaration
    public MethodMeasurement WarmupCount(int count)
    Parameters
    Type Name Description
    System.Int32 count
    Returns
    Type Description
    MethodMeasurement
    Back to top
    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