Class IAdaptivePerformanceSettings

Provider Settings Interface as base class of the provider. Used to control the Editor runtime asset instance which stores the Settings.

Inheritance

Object

UnityEngine.Object

UnityEngine.ScriptableObject

IAdaptivePerformanceSettings

FailToLoadSettings

SimulatorProviderSettings

TestSettings

Inherited Members

UnityEngine.ScriptableObject.SetDirty()

UnityEngine.ScriptableObject.CreateInstance(System.String)

UnityEngine.ScriptableObject.CreateInstance(System.Type)

UnityEngine.ScriptableObject.CreateInstance<T>()

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfType(System.Type, System.Boolean)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type, System.Boolean)

UnityEngine.Object.ToString()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEngine.AdaptivePerformance

Syntax

public class IAdaptivePerformanceSettings : ScriptableObject

Properties

automaticPerformanceMode

The initial value of AutomaticPerformanceControl.

Declaration

public bool automaticPerformanceMode { get; set; }

Property Value

Type	Description
Boolean	Set this to true to enable Automatic Performance Mode, or false to disable it. It is true by default.

defaultScalerProfilerIndex

Default scaler profile index.

Declaration

public int defaultScalerProfilerIndex { get; set; }

Property Value

Type	Description
Int32

enableBoostOnStartup

Whether CPU and GPU boost mode should be enabled on application startup.

Declaration

public bool enableBoostOnStartup { get; set; }

Property Value

Type	Description
Boolean

indexerSettings

Settings of indexer system.

Declaration

public AdaptivePerformanceIndexerSettings indexerSettings { get; set; }

Property Value

Type	Description
AdaptivePerformanceIndexerSettings

logging

Control debug logging. This setting only affects development builds. All logging is disabled in release builds. This setting can also be controlled after startup using Logging. Logging is disabled by default.

Declaration

public bool logging { get; set; }

Property Value

Type	Description
Boolean	Set this to true to enable debug logging, or false to disable it. It is false by default.

scalerSettings

Settings of scaler system.

Declaration

public AdaptivePerformanceScalerSettings scalerSettings { get; set; }

Property Value

Type	Description
AdaptivePerformanceScalerSettings

statsLoggingFrequencyInFrames

Adjust the frequency in frames at which the application logs frame statistics to the console. This is only relevant when logging is enabled. See Logging. This setting can also be controlled after startup using LoggingFrequencyInFrames.

Declaration

public int statsLoggingFrequencyInFrames { get; set; }

Property Value

Type	Description
Int32	Logging frequency in frames (default: 50)

Methods

GetAvailableScalerProfiles()

Returns a list of all available scaler profiles.

Declaration

public string[] GetAvailableScalerProfiles()

Returns

Type	Description
String[]

LoadScalerProfile(String)

Load a scaler profile from the settings. Unity update the values of all scalers in the profile to new ones. This is a heavy operation using reflection and should not be used per frame and only in load operations as it causes hitching and possible screen artifacts depending on which scalers are used in a scene.

Declaration

public void LoadScalerProfile(string scalerProfileName)

Parameters

Type	Name	Description
String	scalerProfileName	Supply the name of the scaler. You can query a list of available scaler profiles via GetAvailableScalerProfiles().

OnEnable()

When Unity enables the serialized object it upgrades old files to the new format in the editor and saves the assets. Empty during runtime.

Declaration

public void OnEnable()