BasicProviderSettings

class in UnityEngine.AdaptivePerformance.Basic

Inherits from:AdaptivePerformance.IAdaptivePerformanceSettings

Leave feedback

Suggest a change

Description

Basic provider Settings.

Inherited Members

Properties

Property	Description
ActiveModeProvider	The currently active mode provider, or null if no provider has been set.
ActiveScalerProfile	The 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.
automaticGameMode	Whether automated target frame rate based on device GameMode settings should be used.
automaticPerformanceMode	The initial value of IDevicePerformanceControl.AutomaticPerformanceControl.
BatteryModeProvider	Returns the default battery mode provider, which is used to control the behavior of the indexer in battery mode.
defaultScalerProfilerIndex	Default scaler profile index.
enableBoostOnStartup	Whether CPU and GPU boost mode should be enabled on application startup.
IndexerOperationMode	Returns 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.
indexerSettings	Settings of indexer system.
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 IDevelopmentSettings.Logging. Logging is disabled by default.
NormalModeProvider	Returns the default normal mode provider, which is used to control the behavior of the indexer in normal mode.
ScalerProfiles	List of created scaler profiles for this provider.
scalerSettings	Settings of scaler system.
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 IDevelopmentSettings.Logging. This setting can also be controlled after startup using IDevelopmentSettings.LoggingFrequencyInFrames.
hideFlags	Controls whether the object is hidden, saved with the scene, and editable by the user.
name	The name of the object.

Public Methods

Method	Description
AddScalerProfileWithDefaultScalers	Add a new scaler profile.
DeleteScalerProfileAt	Delete a scaler profile at the given index.
GetAvailableScalerProfiles	Returns a list of all available scaler profiles.
LoadScalerProfile	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 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.
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.
GetEntityId	Gets the EntityId of the object.
GetHashCode	Returns the hash code for the object.
ToString	Returns the name of the object.

Static Methods

Method	Description
Destroy	Removes a GameObject, component, or asset.
DestroyImmediate	Destroys the specified object immediately. Use with caution and in Edit mode only.
DontDestroyOnLoad	Do not destroy the target Object when loading a new Scene.
FindAnyObjectByType	Retrieves any active loaded object of Type T.
FindObjectsByType	Retrieves a list of all loaded objects of Type type.
Instantiate	Clones the object original and returns the clone.
InstantiateAsync	Captures a snapshot of the original object that's related to another GameObject and obtains an AsyncInstantiateOperation instance of the resulting objects.
CreateInstance	Creates an instance of a scriptable object.

Operators

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

Messages

Message	Description
Awake	Called when an instance of ScriptableObject is created.
OnDestroy	This function is called when the scriptable object will be destroyed.
OnDisable	This function is called when the scriptable object goes out of scope.
OnEnable	This function is called when the object is loaded.
OnValidate	Editor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
Reset	Reset to default values.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Scripting API