Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


IAdaptivePerformanceSettings

Provider Settings Interface as base class of the provider. Used to control the Editor runtime asset instance which stores the Settings.
Read time 6 minutesLast updated 11 days ago

Definition

public class IAdaptivePerformanceSettings : ScriptableObject

Properties

Property

Description

ActiveModeProviderThe currently active mode provider, or
null
if no provider has been set.
ActiveScalerProfileThe currently active scaler profile, or
null
if no profile has been loaded. Only one scaler profile is active at a time. Call IAdaptivePerformanceSettings.LoadScalerProfile to activate one. The getter does not auto-bind to the default profile: a previous lazy initialization here ran before the scalers were actually bound to the profile, which caused LoadScalerProfile's "already loaded" early-out (a Name comparison against ActiveScalerProfile) to short-circuit on first call and skip ApplyScalerProfileToAllScalers, leaving every default scaler with its inline-default settings (base names, default bounds, disabled) until something else triggered a re-apply. Returning null until LoadScalerProfile runs makes "no profile loaded" an honest, observable state and lets the early-out work.
automaticGameModeWhether automated target frame rate based on device GameMode settings should be used.
automaticPerformanceModeThe initial value of IDevicePerformanceControl.AutomaticPerformanceControl.
BatteryModeProviderReturns the default battery mode provider, which is used to control the behavior of the indexer in battery mode.
defaultScalerProfilerIndexDefault scaler profile index.
enableBoostOnStartupWhether CPU and GPU boost mode should be enabled on application startup.
IndexerOperationModeReturns the current operation mode of the indexer. Setting this also propagates the value to IAdaptivePerformanceSettings.ActiveScalerProfile's AdaptivePerformanceScalerSettings.OperationMode so scaler getters reflect the active mode at runtime.
indexerSettingsSettings of indexer system.
loggingControl debug logging. This setting only affects development builds. All logging is disabled in release builds. This setting can also be controlled after startup using IDevelopmentSettings.Logging. Logging is disabled by default.
NormalModeProviderReturns the default normal mode provider, which is used to control the behavior of the indexer in normal mode.
ScalerProfilesList of created scaler profiles for this provider.
scalerSettingsSettings of scaler system.
statsLoggingFrequencyInFramesAdjust the frequency in frames at which the application logs frame statistics to the console. This is only relevant when logging is enabled. See IDevelopmentSettings.Logging. This setting can also be controlled after startup using IDevelopmentSettings.LoggingFrequencyInFrames.

Methods

Method

Description

AddScalerProfileWithDefaultScalersAdd a new scaler profile.
DeleteScalerProfileAtDelete a scaler profile at the given index.
GetAvailableScalerProfilesReturns a list of all available scaler profiles.
LoadScalerProfileLoad a scaler profile from the settings. Unity update the values of all scalers in the profile to new ones. This is a heavy operation 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.
OnEnableWhen Unity enables the serialized object it upgrades old files to the new format in the editor and saves the assets. Empty during runtime.

Inheritance

Inherited Members

Operators

Operator

Description

operator ==Compares two object references to see if they refer to the same object.
boolDetermines whether the object exists.
operator !=Compares if two objects refer to a different object.