Showing the changes to interface/src/scripting/HMDScriptingInterface.h (1 of 1 file). Show all
Unified · Split
| @@ -1,4 +1,4 @@ | |||
| 1 | 1 | // | |
| 2 | // HMDScriptingInterface.h | 2 | // HMDScriptingInterface.h |
| 3 | // interface/src/scripting | 3 | // interface/src/scripting |
| 4 | // | 4 | // |
| @@ -197,7 +197,7 @@ public: · 192 unmodified lines | |||
| 197 | * Checks whether there is an HMD available. | 197 | * Checks whether there is an HMD available. |
| 198 | * @function HMD.isHMDAvailable | 198 | * @function HMD.isHMDAvailable |
| 199 | * @param {string} [name=""] - The name of the HMD to check for, e.g., <code>"Oculus Rift"</code>. The name is the same as | 199 | * @param {string} [name=""] - The name of the HMD to check for, e.g., <code>"Oculus Rift"</code>. The name is the same as |
| 200 | * may be displayed in Interface's "Display" menu. If no name is specified then any HMD matches. | 200 | * may be displayed in Interface's "Display" menu. If no name is specified, then any HMD matches. |
| 201 | * @returns {boolean} <code>true</code> if an HMD of the specified <code>name</code> is available, otherwise | 201 | * @returns {boolean} <code>true</code> if an HMD of the specified <code>name</code> is available, otherwise |
| 202 | * <code>false</code>. | 202 | * <code>false</code>. |
| 203 | * @example <caption>Report on HMD availability.</caption> | 203 | * @example <caption>Report on HMD availability.</caption> |
| @@ -211,7 +211,7 @@ public: · 7 unmodified lines | |||
| 211 | * Checks whether there is an HMD head controller available. | 211 | * Checks whether there is an HMD head controller available. |
| 212 | * @function HMD.isHeadControllerAvailable | 212 | * @function HMD.isHeadControllerAvailable |
| 213 | * @param {string} [name=""] - The name of the HMD head controller to check for, e.g., <code>"Oculus"</code>. If no name is | 213 | * @param {string} [name=""] - The name of the HMD head controller to check for, e.g., <code>"Oculus"</code>. If no name is |
| 214 | * specified then any HMD head controller matches. | 214 | * specified, then any HMD head controller matches. |
| 215 | * @returns {boolean} <code>true</code> if an HMD head controller of the specified <code>name</code> is available, | 215 | * @returns {boolean} <code>true</code> if an HMD head controller of the specified <code>name</code> is available, |
| 216 | * otherwise <code>false</code>. | 216 | * otherwise <code>false</code>. |
| 217 | * @example <caption>Report HMD head controller availability.</caption> | 217 | * @example <caption>Report HMD head controller availability.</caption> |
| @@ -225,7 +225,7 @@ public: · 7 unmodified lines | |||
| 225 | * Checks whether there are HMD hand controllers available. | 225 | * Checks whether there are HMD hand controllers available. |
| 226 | * @function HMD.isHandControllerAvailable | 226 | * @function HMD.isHandControllerAvailable |
| 227 | * @param {string} [name=""] - The name of the HMD hand controller to check for, e.g., <code>"Oculus"</code>. If no name is | 227 | * @param {string} [name=""] - The name of the HMD hand controller to check for, e.g., <code>"Oculus"</code>. If no name is |
| 228 | * specified then any HMD hand controller matches. | 228 | * specified, then any HMD hand controller matches. |
| 229 | * @returns {boolean} <code>true</code> if an HMD hand controller of the specified <code>name</code> is available, | 229 | * @returns {boolean} <code>true</code> if an HMD hand controller of the specified <code>name</code> is available, |
| 230 | * otherwise <code>false</code>. | 230 | * otherwise <code>false</code>. |
| 231 | * @example <caption>Report HMD hand controller availability.</caption> | 231 | * @example <caption>Report HMD hand controller availability.</caption> |
| @@ -293,7 +293,7 @@ public: · 61 unmodified lines | |||
| 293 | 293 | ||
| 294 | /**jsdoc | 294 | /**jsdoc |
| 295 | * Suppresses the activation of the HMD-provided keyboard, if any. Successful calls should be balanced with a call to | 295 | * Suppresses the activation of the HMD-provided keyboard, if any. Successful calls should be balanced with a call to |
| 296 | * {@link HMD.unspressKeyboard|unspressKeyboard} within a reasonable amount of time. | 296 | * {@link HMD.unsuppressKeyboard|unsuppressKeyboard} within a reasonable amount of time. |
| 297 | * @function HMD.suppressKeyboard | 297 | * @function HMD.suppressKeyboard |
| 298 | * @returns {boolean} <code>true</code> if the current HMD provides a keyboard and it was successfully suppressed (e.g., it | 298 | * @returns {boolean} <code>true</code> if the current HMD provides a keyboard and it was successfully suppressed (e.g., it |
| 299 | * isn't being displayed), otherwise <code>false</code>. | 299 | * isn't being displayed), otherwise <code>false</code>. |