Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

AdaptiveResolution

class in UnityEngine.AdaptivePerformance

/

Inherits from:AdaptivePerformance.AdaptivePerformanceScaler

/

Implemented in:UnityEngine.AdaptivePerformanceModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A scaler used by AdaptivePerformanceIndexer to adjust the resolution of all render targets that allow dynamic resolution. If a device or graphics API doesn't support a dynamic resolution, it will use the rendering pipeline's render scale multiplier as a fallback.

Protected Methods

Method Description
Awake Ensures settings are applied during startup.
OnDisabled Callback when scaler gets disabled and removed from indexer
OnEnabled Callback when scaler gets enabled and added to the indexer
OnLevel Callback for any level change

Inherited Members

Properties

PropertyDescription
CpuImpact Scaler impact on CPU so far in milliseconds.
CurrentLevel Returns the current level of scale.
Enabled Returns true if this scaler is active, otherwise returns false.
GpuImpact Scaler impact on GPU so far in milliseconds.
IsMaxLevel Returns true if the scaler can no longer be applied, otherwise returns false.
MaxBound Returns the maximum boundary of this scaler.
MaxLevel Returns the maximum level of this scaler.
MinBound Returns the minimum boundary of this scaler.
Name Returns a string with the name of the scaler.
NotLeveled Returns true if the scaler is not applied, otherwise returns false.
OverrideLevel Allows you to manually override the scaler level. If the value is -1, AdaptivePerformanceIndexer will handle levels, otherwise scaler will be forced to the value you specify.
Scale Returns a generic scale of this scaler in range [0,1] which is applied to the quality.
Target Returns the bottlenecks that this scaler targets.
VisualImpact Returns the visual impact of scaler when applied.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

MethodDescription
ApplyDefaultSetting Any scaler with settings in IAdaptivePerformanceSettings needs to call this method and provide the scaler specific setting. Unity uses the setting arguments in the base-scaler as the default settings. This is also used by Scaler Profiles to apply their Settings.
CalculateCost Calculate the cost of applying this particular scaler.
GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Protected Methods

MethodDescription
OnLevelDecrease Callback for when the performance level is decreased.
OnLevelIncrease Callback for when the performance level is increased.
ScaleChanged Checks if scale changed based on the current level and returns true if scale changed false otherwise.

Static Methods

MethodDescription
DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.
CreateInstanceCreates an instance of a scriptable object.

Operators

OperatorDescription
boolDoes the object exist?
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

MessageDescription
OnDestroyThis function is called when the scriptable object will be destroyed.
OnDisableThis function is called when the scriptable object goes out of scope.
OnEnableThis function is called when the object is loaded.
OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
ResetReset to default values.