AdaptivePerformanceBatteryModeProvider
The built-in operation mode that prioritizes battery life over performance.
Read time 1 minuteLast updated 12 days ago
Definition
- Type: Class
- Namespace: UnityEngine.AdaptivePerformance
- Assembly: UnityEngine.AdaptivePerformanceModule
- Implements: IAdaptivePerformanceModeProvider
public class AdaptivePerformanceBatteryModeProvider : IAdaptivePerformanceModeProvider
Remarks
Battery mode reduces the target frame rate and enables battery-oriented scalers such as AdaptiveOnDemandRendering, AdaptivePhysics, and AdaptiveFramerate. It also lowers quality further while the player is idle. Refer to AdaptivePerformanceIdleTimeTracker for idle detection. Where the active provider supports it, battery mode requests the device's energy-efficiency mode through IDevicePerformanceLevelControl.SetEnergyEfficiencyMode.
Properties
Property | Description |
|---|---|
| CpuUtilizationAction | The action the mode applies in response to the device's CPU utilization data. |
| GpuUtilizationAction | The action the mode applies in response to the device's GPU utilization data. |
| IdleTimeThresholdInSeconds | The number of seconds the player must be idle before battery mode applies additional idle-based scaling. |
| Indexer | The Indexer that this mode adjusts scalers through. |
| ModeName | The name of the operation mode. |
| PerformanceAction | The action the mode applies in response to the device's performance state. |
| SavingTarget | The fraction of frame time that battery mode tries to save once the target frame rate is met, in the range [0, 1]. |
| Settings | The active Adaptive Performance settings. |
| ThermalAction | The action the mode applies in response to the device's thermal state. |
Methods
Method | Description |
|---|---|
| ApplyModeActions | Applies battery mode's idle, thermal, and performance actions to the active scalers. Adaptive Performance calls this method every frame while battery mode is active. |
| OnOperationModeEnd | Called when battery mode is replaced by another operation mode. Restores the scalers it enabled and releases the device's energy-efficiency hint. |
| OnOperationModeStart | Called when battery mode becomes the active operation mode. Prepares the Indexer and enables the battery-oriented scalers. |