Version: Unity 6.7 Beta (6000.7)
LanguageEnglish
  • C#

IEnergyUsageControl.StartEnergyUsageTracking

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public bool StartEnergyUsageTracking();

Returns

bool True if tracking was started or reset; false if energy-usage tracking is not supported on this device or Adaptive Performance is not active.

Description

Starts energy-usage tracking, or resets the baseline if tracking is already active so that subsequent PerformanceMetrics.EnergyUsage readings are measured from now.

A false result has two causes: energy-usage tracking is not supported on this device, or Adaptive Performance is not currently active. In the latter case tracking can succeed once Adaptive Performance becomes active, so check IAdaptivePerformance.Active before giving up.