Class AdaptivePerformanceIndexer

Higher level implementation of Adaptive performance that tracks performance and thermal states of the device and provides them to AdaptivePerformanceScaler which use the information to increase or decrease performance levels. System acts as AdaptivePerformanceScaler manager and handles the lifetime of the scalers in the scenes.

Inheritance

Object

AdaptivePerformanceIndexer

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEngine.AdaptivePerformance

Syntax

public class AdaptivePerformanceIndexer

Properties

PerformanceAction

Current determined action needed from performance state. Action Increase will be ignored if ThermalAction is decreasing.

Declaration

public StateAction PerformanceAction { get; }

Property Value

Type	Description
StateAction

ThermalAction

Current determined action needed from thermal state. Action Increase will be ignored if PerformanceAction is decreasing.

Declaration

public StateAction ThermalAction { get; }

Property Value

Type	Description
StateAction

TimeUntilNextAction

Time left until next action.

Declaration

public float TimeUntilNextAction { get; }

Property Value

Type	Description
Single

Methods

DeltaTime()

Returns UnityEngine.Time.deltaTime only and is primarily encapsulated for tests.

Declaration

protected virtual float DeltaTime()

Returns

Type	Description
Single	delta time

GetAllRegisteredScalers(ref List<AdaptivePerformanceScaler>)

Returns all scalers independent of their state.

Declaration

public void GetAllRegisteredScalers(ref List<AdaptivePerformanceScaler> scalers)

Parameters

Type	Name	Description
List<AdaptivePerformanceScaler>	scalers	Output where scalers will be written.

GetAppliedScalers(ref List<AdaptivePerformanceScaler>)

Returns all currently applied scalers.

Declaration

public void GetAppliedScalers(ref List<AdaptivePerformanceScaler> scalers)

Parameters

Type	Name	Description
List<AdaptivePerformanceScaler>	scalers	Output where scalers will be written.

GetDisabledScalers(ref List<AdaptivePerformanceScaler>)

Returns all currently disabled scalers.

Declaration

public void GetDisabledScalers(ref List<AdaptivePerformanceScaler> scalers)

Parameters

Type	Name	Description
List<AdaptivePerformanceScaler>	scalers	Output where scalers will be written.

GetUnappliedScalers(ref List<AdaptivePerformanceScaler>)

Returns all currently unapplied scalers.

Declaration

public void GetUnappliedScalers(ref List<AdaptivePerformanceScaler> scalers)

Parameters

Type	Name	Description
List<AdaptivePerformanceScaler>	scalers	Output where scalers will be written.

UnapplyAllScalers()

Unapply all currently active scalers.

Declaration

public void UnapplyAllScalers()