Showing the changes to interface/src/scripting/WindowScriptingInterface.h (1 of 5 files). Show all
Unified · Split
| @@ -367,9 +367,9 @@ public slots: · 366 unmodified lines | ||
| 367 | 367 | void takeSecondaryCameraSnapshot(const QString& filename = QString()); |
| 368 | 368 | |
| 369 | 369 | /**jsdoc |
| 370 | − * Takes a 360 snapshot of the current view from the secondary camera that can be set up through the {@link Render} API. | |
| 371 | − * NOTE: to provide a non-default value - all previous parameters must be provided. | |
| 370 | + * Takes a 360 snapshot given a position of the secondary camera (which does not need to have been previously set up). | |
| 372 | 371 | * @function Window.takeSecondaryCameraSnapshot |
| 372 | + * @param {vec3} [cameraPosition] - The (x, y, z) position of the camera for the 360 snapshot | |
| 373 | 373 | * @param {string} [filename=""] - If this parameter is not given, the image will be saved as 'hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS'. |
| 374 | 374 | * If this parameter is <code>""</code> then the image will be saved as ".jpg". |
| 375 | 375 | * Otherwise, the image will be saved to this filename, with an appended ".jpg". |
| @@ -587,10 +587,10 @@ signals: · 211 unmodified lines | ||
| 587 | 587 | void stillSnapshotTaken(const QString& pathStillSnapshot, bool notify); |
| 588 | 588 | |
| 589 | 589 | /**jsdoc |
| 590 | − * Triggered when a still equirectangular snapshot has been taken by calling {@link Window.take360Snapshot|take360Snapshot} | |
| 590 | + * Triggered when a still equirectangular snapshot has been taken by calling {@link Window.takeSecondaryCamera360Snapshot|takeSecondaryCamera360Snapshot} | |
| 591 | 591 | * @function Window.equirectangularSnapshotTaken |
| 592 | 592 | * @param {string} pathStillSnapshot - The path and name of the snapshot image file. |
| 593 | − * @param {boolean} notify - The value of the <code>notify</code> parameter that {@link Window.take360Snapshot|take360Snapshot} | |
| 593 | + * @param {boolean} notify - The value of the <code>notify</code> parameter that {@link Window.takeSecondaryCamera360Snapshot|takeSecondaryCamera360Snapshot} | |
| 594 | 594 | * was called with. |
| 595 | 595 | * @returns {Signal} |
| 596 | 596 | */ |