IAdaptivePerformanceSettings
Provider Settings Interface as base class of the provider. Used to control the Editor runtime asset instance which stores the Settings.
Read time 5 minutesLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEngine.AdaptivePerformance
- Assembly: UnityEngine.AdaptivePerformanceModule
- Inherits from: ScriptableObject
public class IAdaptivePerformanceSettings : ScriptableObject
Properties
Property | Description |
|---|---|
| ActiveScalerProfile | The currently active scaler profile. Only one scaler profile is active at a time. |
| automaticGameMode | Whether automated target frame rate based on device GameMode settings should be used. |
| automaticPerformanceMode | The initial value of IDevicePerformanceControl.AutomaticPerformanceControl. |
| defaultScalerProfilerIndex | Default scaler profile index. |
| enableBoostOnStartup | Whether CPU and GPU boost mode should be enabled on application startup. |
| 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. |
| 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. |
Methods
Method | Description |
|---|---|
| AddScalerProfileWithDefaultScalers | Add a new scaler profile with default scaler settings. |
| 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 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. |
| 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. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |