Mirrors/overte-Armored-Dragon
3
0
Fork 0
mirror of https://github.com/Armored-Dragon/overte.git synced 2025-03-11 16:13:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Rates JSDoc

Browse source
This commit is contained in:
David Rowe 2019-12-10 13:33:40 +13:00
parent 9dc1167e73
commit 6750d02228
1 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
interface/src/scripting/RatesScriptingInterface.h
View file

@ -14,6 +14,41 @@
#include <display-plugins/DisplayPlugin.h>
/**jsdoc
* The <code>Rates</code> API provides some information on current rendering performance.
*
* @namespace Rates
*
* @hifi-interface
* @hifi-client-entity
* @hifi-avatar
*
* @property {number} render - The rate at which new GPU frames are being created, in Hz.
* <em>Read-only.</em>
* @property {number} present - The rate at which the display plugin is presenting to the display device, in Hz
* <em>Read-only.</em>
* @property {number} newFrame - The rate at which the display plugin is presenting new GPU frames, in Hz.
* <em>Read-only.</em>
* @property {number} dropped - The rate at which the display plugin is dropping GPU frames, in Hz.
* <em>Read-only.</em>
* @property {number} simulation - The rate at which the game loop is running, in Hz.
* <em>Read-only.</em>
*
* @example <caption>Report current rendering rates.</caption>
* // The rates to report.
* var rates = [
* "render",
* "present",
* "newFrame",
* "dropped",
* "simulation"
* ];
*
* // Report the rates.
* for (var i = 0; i < rates.length; i++) {
* print("Rates." + rates[i], "=", Rates[rates[i]]);
* }
*/
class RatesScriptingInterface : public QObject {
Q_OBJECT