Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


PerformanceMetrics

PerformanceMetrics store the current bottleneck, CPU, and GPU levels
Read time 1 minuteLast updated 6 days ago

Definition

public struct PerformanceMetrics

Properties

Property

Description

ClusterInfoCurrent CPU cluster information information. Updated at application startup.
CpuPerformanceBoostCPU boosted.
CpuUtilizationCurrent normalized CPU utilization in the range of [0.0, 1.0], or -1.0 when not available. A value of 0.0 indicates the CPU is lightly loaded. A value of 1.0 indicates the CPU is heavily loaded. When a provider does not supply this value directly, it is -1.0.
CurrentCpuLevelCurrent CPU performance level. This value updates once per frame when changes are applied to IDevicePerformanceControl.CpuLevel. Value in the range [Constants.MinCpuPerformanceLevel, IDevicePerformanceControl.MaxCpuPerformanceLevel] or Constants.UnknownPerformanceLevel.
CurrentGpuLevelCurrent GPU performance level. This value updates once per frame when changes are applied to IDevicePerformanceControl.GpuLevel. Value in the range [Constants.MinGpuPerformanceLevel, IDevicePerformanceControl.MaxGpuPerformanceLevel] or Constants.UnknownPerformanceLevel.
EnergyUsageLatest cross-platform per-subsystem energy consumption since energy-usage tracking was started or reset. Only meaningful while energy-usage tracking is active (see IEnergyUsageControl) and the active provider supports Feature.EnergyUsage. Updates at the platform's native cadence, which can be considerably slower than once per frame.
GpuPerformanceBoostGPU boosted.
GpuUtilizationCurrent normalized GPU utilization in the range of [0.0, 1.0], or -1.0 when not available. A value of 0.0 indicates the GPU is lightly loaded. A value of 1.0 indicates the GPU is heavily loaded. When a provider does not supply this value directly, it is -1.0.
LowPowerModeTrue when the platform reports a low-power condition. Populated from Feature.LowPowerMode. False when the capability is unsupported by the active provider.
PerformanceBottleneckCurrent performance bottleneck which describes if the program is CPU, GPU, or
Application.targetFrameRate
bound.