Class FramesMeasurement

Inheritance

System.Object

FramesMeasurement

Namespace: Unity.PerformanceTesting.Measurements

Syntax

public class FramesMeasurement

Methods

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

Declaration

public FramesMeasurement Definition(string name = "Time", 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
FramesMeasurement

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

Declaration

public FramesMeasurement 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
FramesMeasurement

Definition(SampleGroupDefinition)

Declaration

public FramesMeasurement Definition(SampleGroupDefinition definition)

Parameters

Type	Name	Description
SampleGroupDefinition	definition

Returns

Type	Description
FramesMeasurement

DontRecordFrametime()

Declaration

public FramesMeasurement DontRecordFrametime()

Returns

Type	Description
FramesMeasurement

MeasurementCount(Int32)

Declaration

public FramesMeasurement MeasurementCount(int count)

Parameters

Type	Name	Description
System.Int32	count

Returns

Type	Description
FramesMeasurement

ProfilerMarkers(SampleGroupDefinition[])

Declaration

public FramesMeasurement ProfilerMarkers(params SampleGroupDefinition[] profilerDefinitions)

Parameters

Type	Name	Description
SampleGroupDefinition[]	profilerDefinitions

Returns

Type	Description
FramesMeasurement

Run()

Declaration

public IEnumerator Run()

Returns

Type	Description
System.Collections.IEnumerator

Scope()

Declaration

public ScopedFrameTimeMeasurement Scope()

Returns

Type	Description
ScopedFrameTimeMeasurement

Scope(SampleGroupDefinition)

Declaration

public ScopedFrameTimeMeasurement Scope(SampleGroupDefinition sampleGroupDefinition)

Parameters

Type	Name	Description
SampleGroupDefinition	sampleGroupDefinition

Returns

Type	Description
ScopedFrameTimeMeasurement

WarmupCount(Int32)

Declaration

public FramesMeasurement WarmupCount(int count)

Parameters

Type	Name	Description
System.Int32	count

Returns

Type	Description
FramesMeasurement