Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-08-08 12:48:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Revise display plugin JSDoc in the Window API

Browse source
This commit is contained in:
David Rowe 2019-05-17 21:34:36 +12:00
parent b09247d191
commit 4ce2c39d0a
1 changed files with 20 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
interface/src/scripting/WindowScriptingInterface.h
View file

@ -559,39 +559,47 @@ public slots:
float domainLoadingProgress(); float domainLoadingProgress();
/**jsdoc /**jsdoc
* Return the number of display plugins currently available * Gets the number of display plugins currently available.
* @function Window.getDisplayPluginCount * @function Window.getDisplayPluginCount
* @returns {int} The number of currently available display plugins * @returns {number} The number of display plugins currently available.
*/ */
int getDisplayPluginCount(); int getDisplayPluginCount();
/**jsdoc /**jsdoc
* Return the human readable name of a display plugin * Gets the name of a display plugin.
* @function Window.getDisplayPluginName * @function Window.getDisplayPluginName
* @param {int} index - The index of the display plugin. Must be less than the value returned by {@link Window.getDisplayPluginCount|getDisplayPluginCount}. * @param {number} index - The index of the display plugin. Must be less than the value returned by
* @returns {string} The name of the specified display plugin * {@link Window.getDisplayPluginCount|getDisplayPluginCount}. The first display plugin has an index of <code>0</code>.
* @returns {string} The name of the display plugin.
* @example <caption>Print the names of all available display plugins.</caption>
* for (var i = 0, length = Window.getDisplayPluginCount(); i < length; i++) {
* print(Window.getDisplayPluginName(i));
* }
*/ */
QString getDisplayPluginName(int index); QString getDisplayPluginName(int index);
/**jsdoc /**jsdoc
* Return whether a given display plugin is an HMD * Checks whether a display plugin is an HMD.
* @function Window.isDisplayPluginHmd * @function Window.isDisplayPluginHmd
* @param {int} index - The index of the display plugin. Must be less than the value returned by {@link Window.getDisplayPluginCount|getDisplayPluginCount}. * @param {number} index - The index of the display plugin. Must be less than the value returned by
* @returns {bool} True if the specified display plugin is a HMD * {@link Window.getDisplayPluginCount|getDisplayPluginCount}. The first display plugin has an index of <code>0</code>.
* @returns {boolean} <code>true</code> if the display plugin is a HMD, <code>false</code> if it isn't.
*/ */
bool isDisplayPluginHmd(int index); bool isDisplayPluginHmd(int index);
/**jsdoc /**jsdoc
* Return the currently active display plugin * Gets the index of the currently active display plugin.
* @function Window.getActiveDisplayPlugin * @function Window.getActiveDisplayPlugin
* @returns {int} The index of the currently active display plugin * @returns {number} The index of the currently active display plugin. The first display plugin has an index of
* <code>0</code>.
*/ */
int getActiveDisplayPlugin(); int getActiveDisplayPlugin();
/**jsdoc /**jsdoc
* Return the currently active display plugin * Sets the currently active display plugin.
* @function Window.setActiveDisplayPlugin * @function Window.setActiveDisplayPlugin
* @param {int} index - The index of the display plugin. Must be less than the value returned by {@link Window.getDisplayPluginCount|getDisplayPluginCount}. * @param {number} index - The index of the display plugin. Must be less than the value returned by
* {@link Window.getDisplayPluginCount|getDisplayPluginCount}. The first display plugin has an index of <code>0</code>.
*/ */
void setActiveDisplayPlugin(int index); void setActiveDisplayPlugin(int index);