108 lines
7.8 KiB
HTML
108 lines
7.8 KiB
HTML
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><title>Python: package telemetry.core.platform</title>
|
|
</head><body bgcolor="#f0f0f8">
|
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
|
<tr bgcolor="#7799ee">
|
|
<td valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.core.html"><font color="#ffffff">core</font></a>.platform</strong></big></big></font></td
|
|
><td align=right valign=bottom
|
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/core/platform/__init__.py">telemetry/core/platform/__init__.py</a></font></td></tr></table>
|
|
<p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br>
|
|
# Use of this source code is governed by a BSD-style license that can be<br>
|
|
# found in the LICENSE file.</tt></p>
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#aa55cc">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.platform.android_platform_backend.html">android_platform_backend</a><br>
|
|
<a href="telemetry.core.platform.cros_platform_backend.html">cros_platform_backend</a><br>
|
|
<a href="telemetry.core.platform.linux_platform_backend.html">linux_platform_backend</a><br>
|
|
</td><td width="25%" valign=top><a href="telemetry.core.platform.mac_platform_backend.html">mac_platform_backend</a><br>
|
|
<a href="telemetry.core.platform.platform_backend.html">platform_backend</a><br>
|
|
<a href="telemetry.core.platform.posix_platform_backend.html">posix_platform_backend</a><br>
|
|
</td><td width="25%" valign=top><a href="telemetry.core.platform.posix_platform_backend_unittest.html">posix_platform_backend_unittest</a><br>
|
|
<a href="telemetry.core.platform.profiler.html"><strong>profiler</strong> (package)</a><br>
|
|
<a href="telemetry.core.platform.win_platform_backend.html">win_platform_backend</a><br>
|
|
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ee77aa">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
|
<td width="100%"><dl>
|
|
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="telemetry.core.platform.html#Platform">Platform</a>
|
|
</font></dt></dl>
|
|
</dd>
|
|
</dl>
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="Platform">class <strong>Platform</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>The platform that the target browser is running on.<br>
|
|
<br>
|
|
Provides a limited interface to interact with the platform itself, where<br>
|
|
possible. It's important to note that platforms may not provide a specific<br>
|
|
API, so check with IsFooBar() for availability.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="Platform-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt><dd><tt>Platforms may be able to detect thermal throttling.<br>
|
|
<br>
|
|
Some fan-less computers go into a reduced performance mode when their heat<br>
|
|
exceeds a certain threshold. Performance tests in particular should use this<br>
|
|
API to detect if this has happened and interpret results accordingly.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-GetOSName"><strong>GetOSName</strong></a>(self)</dt><dd><tt>Returns a string description of the <a href="#Platform">Platform</a> OS.<br>
|
|
<br>
|
|
Examples: WIN, MAC, LINUX, CHROMEOS</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt><dd><tt>Returns a string description of the <a href="#Platform">Platform</a> OS version.<br>
|
|
<br>
|
|
Examples: VISTA, WIN7, LION, MOUNTAINLION</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt><dd><tt>Returns a list of RawDisplayFrameRateMeasurement.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt><dd><tt>Returns True if the device has been thermally throttled.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt><dd><tt>Platforms may be able to collect GL surface stats.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt><dd><tt>Returns True if the device is currently thermally throttled.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt><dd><tt>Platforms may tweak their CPU governor, system status, etc.<br>
|
|
<br>
|
|
Most platforms can operate in a battery saving mode. While good for battery<br>
|
|
life, this can cause confusing performance results and add noise. Turning<br>
|
|
full performance mode on disables these features, which is useful for<br>
|
|
performance testing.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Start measuring GL surface stats.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Stop measuring GL surface stats.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Platform-__init__"><strong>__init__</strong></a>(self, platform_backend)</dt></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Data and other attributes defined here:<br>
|
|
<dl><dt><strong>RawDisplayFrameRateMeasurement</strong> = <class 'telemetry.core.platform.RawDisplayFrameRateMeasurement'></dl>
|
|
|
|
</td></tr></table></td></tr></table>
|
|
</body></html> |