diff --git a/interface/src/scripting/DesktopScriptingInterface.h b/interface/src/scripting/DesktopScriptingInterface.h index c25f382891..e75bd571e8 100644 --- a/interface/src/scripting/DesktopScriptingInterface.h +++ b/interface/src/scripting/DesktopScriptingInterface.h @@ -22,7 +22,7 @@ /**jsdoc * The Desktop API provides the dimensions of the computer screen, sets the opacity of the HUD surface, and * enables QML and HTML windows to be shown inside or outside of Interface. - * + * * @namespace Desktop * * @hifi-interface diff --git a/interface/src/scripting/RatesScriptingInterface.h b/interface/src/scripting/RatesScriptingInterface.h index 5658ed99a0..6feef94d17 100644 --- a/interface/src/scripting/RatesScriptingInterface.h +++ b/interface/src/scripting/RatesScriptingInterface.h @@ -14,6 +14,41 @@ #include +/**jsdoc + * The Rates 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. + * Read-only. + * @property {number} present - The rate at which the display plugin is presenting to the display device, in Hz. + * Read-only. + * @property {number} newFrame - The rate at which the display plugin is presenting new GPU frames, in Hz. + * Read-only. + * @property {number} dropped - The rate at which the display plugin is dropping GPU frames, in Hz. + * Read-only. + * @property {number} simulation - The rate at which the game loop is running, in Hz. + * Read-only. + * + * @example Report current rendering rates. + * // 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 diff --git a/tools/jsdoc/plugins/hifi.js b/tools/jsdoc/plugins/hifi.js index 0da2a34c48..496b144218 100644 --- a/tools/jsdoc/plugins/hifi.js +++ b/tools/jsdoc/plugins/hifi.js @@ -26,7 +26,7 @@ exports.handlers = { '../../assignment-client/src/octree', '../../interface/src', '../../interface/src/assets', - //'../../interface/src/audio', Exlude AudioScope API from output. + //'../../interface/src/audio', Exclude AudioScope API from output. '../../interface/src/avatar', '../../interface/src/commerce', '../../interface/src/java',