Interface IDevicePerformanceControl

The device performance control interface handles all control elements related to the device performance. You can change the AutomaticPerformanceControl settings or retrieve information about the CpuLevel and GpuLevel.

Namespace: UnityEngine.AdaptivePerformance

Assembly: Unity.AdaptivePerformance.dll

Syntax

public interface IDevicePerformanceControl

Properties

AutomaticPerformanceControl

When set to true, which is the default value, Adaptive Performance automatically sets CpuLevel and GpuLevel.

Declaration

bool AutomaticPerformanceControl { get; set; }

Property Value

Type	Description
bool	True when Adaptive Performance controls CpuLevel and GpuLevel, otherwise false. The default value is true.

CpuLevel

The requested CPU performance level. Higher levels typically allow CPU cores to run at higher clock speeds. The consequence is that thermal warnings and throttling might happen sooner when the device cannot sustain high clock speeds. Changes are applied once per frame. It is recommended to set the CpuLevel as low as possible to save power. The valid value range is [MinCpuPerformanceLevel, MaxCpuPerformanceLevel].

Declaration

int CpuLevel { get; set; }

Property Value

Type	Description
int	The requested CPU performance level

CpuPerformanceBoost

The requested CPU boost mode state. Enabled typically allows CPU cores to run at higher clock speeds. The consequence is that thermal warnings and throttling might happen sooner when the device cannot sustain high clock speeds. Changes are applied once per frame. It is recommended to not use a boost often and certainly not continuously to save power.

Declaration

bool CpuPerformanceBoost { get; set; }

Property Value

Type	Description
bool	True when CPU boost is active, otherwise false. The default value is false.

GpuLevel

The requested GPU performance level. Higher levels typically allow the GPU to run at higher clock speeds. The consequence is that thermal warnings and throttling might happen sooner when the device cannot sustain high clock speeds. Changes are applied once per frame. It is recommended to set the GpuLevel as low as possible to save power. The valid value range is [MinGpuPerformanceLevel, MaxGpuPerformanceLevel].

Declaration

int GpuLevel { get; set; }

Property Value

Type	Description
int	The requested GPU performance level

GpuPerformanceBoost

The requested GPU boost mode state. Enabled typically allows GPU cores to run at higher clock speeds. The consequence is that thermal warnings and throttling might happen sooner when the device cannot sustain high clock speeds. Changes are applied once per frame. It is recommended to not use a boost often and certainly not continuously to save power.

Declaration

bool GpuPerformanceBoost { get; set; }

Property Value

Type	Description
bool	True when CPU boost is active, otherwise false. The default value is false.

MaxCpuPerformanceLevel

The maximum valid CPU performance level you use with CpuLevel. The minimum value returned is MinCpuPerformanceLevel. This value does not change after startup is complete.

Declaration

int MaxCpuPerformanceLevel { get; }

Property Value

Type	Description
int

MaxGpuPerformanceLevel

The maximum valid GPU performance level you use with GpuLevel. The minimum value returned is MinGpuPerformanceLevel. This value does not change after startup is complete.

Declaration

int MaxGpuPerformanceLevel { get; }

Property Value

Type	Description
int

PerformanceControlMode

The current PerformanceControlMode. PerformanceControlMode is affected by AutomaticPerformanceControl.

Declaration

PerformanceControlMode PerformanceControlMode { get; }

Property Value

Type	Description
PerformanceControlMode	The current PerformanceControlMode