class in UnityEngine.AdaptivePerformance
/
Inherits from:AdaptivePerformance.AdaptivePerformanceScaler
A scaler used by AdaptivePerformanceIndexer for adjusting layer culling distances.
| 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. |
| Property | Description |
|---|---|
| BatteryModeSetting | Default settings for this scaler in battery mode. |
| CpuImpact | Scaler impact on CPU so far in milliseconds. |
| CurrentLevel | Returns the current level of scale. |
| DefaultSetting | Default settings for this scaler in normal mode. |
| Enabled | Returns true if this scaler is active, otherwise returns false. Routed through AdaptivePerformance.AdaptivePerformanceScaler.ActiveSetting, so reads and writes target the current mode's per-mode settings struct. Switching IAdaptivePerformanceSettings.IndexerOperationMode changes which struct this getter reads from, so per-mode enabled state takes effect on mode change without any explicit sync. |
| GpuImpact | Scaler impact on GPU so far in milliseconds. |
| IndexerOperationMode | Returns the current operation mode of the indexer. |
| 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. |
| hideFlags | Controls whether the object is hidden, saved with the scene, and editable by the user. |
| name | The name of the object. |
| Method | Description |
|---|---|
| ApplyBatteryModeSetting | Apply battery mode settings to the scaler. This allows scalers to have separate configurations for normal and battery operation modes. This is used by Scaler Profiles to apply battery mode settings. |
| 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. |
| GetEntityId | Gets the EntityId of the object. |
| GetHashCode | Returns the hash code for the object. |
| ToString | Returns the name of the object. |
| Method | Description |
|---|---|
| ApplyProfileSettings | Hydrates this scaler from a profile setting in one shot: installs the per-mode override for every mode (default / battery). Enabled state rides inside each mode's settings struct, so applying the per-mode structs is sufficient — AdaptivePerformanceScaler.Enabled reads from the active struct via AdaptivePerformance.AdaptivePerformanceScaler.ActiveSetting. Intended for subclasses to call from Awake with their own typed setting, e.g. ApplyProfileSettings(m_Settings.scalerSettings.AdaptivePhysics). No-op if setting is null. |
| OnLevelDecrease | Callback for when the performance level is decreased. |
| OnLevelIncrease | Callback for when the performance level is increased. |
| OnOperationMode | Callback every frame for actions in a specific mode. |
| ScaleChanged | Checks if scale changed based on the current level and returns true if scale changed false otherwise. |
| 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. |
| 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. |
| Message | Description |
|---|---|
| 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. |