Showing the changes to interface/src/scripting/WindowScriptingInterface.h (1 of 1 file). Show all
Unified · Split
| @@ -318,7 +318,6 @@ public slots: · 317 unmodified lines | ||
| 318 | 318 | * {@link Window.stillSnapshotTaken|stillSnapshotTaken} is emitted; when a still image plus moving images are captured, |
| 319 | 319 | * {@link Window.processingGifStarted|processingGifStarted} and {@link Window.processingGifCompleted|processingGifCompleted} |
| 320 | 320 | * are emitted. The path to store the snapshots and the length of the animated GIF to capture are specified in Settings > |
| 321 | − * NOTE: to provide a non-default value - all previous parameters must be provided. | |
| 322 | 321 | * General > Snapshots. |
| 323 | 322 | * @function Window.takeSnapshot |
| 324 | 323 | * @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken} |
| @@ -328,7 +327,7 @@ public slots: · 3 unmodified lines | ||
| 328 | 327 | * @param {number} [aspectRatio=0] - The width/height ratio of the snapshot required. If the value is <code>0</code> the |
| 329 | 328 | * full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one of the |
| 330 | 329 | * dimensions is adjusted in order to match the aspect ratio. |
| 331 | − * @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'. | |
| 330 | + * @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". | |
| 332 | 331 | * If this parameter is <code>""</code> then the image will be saved as ".jpg". |
| 333 | 332 | * Otherwise, the image will be saved to this filename, with an appended ".jpg". |
| 334 | 333 | * |
| @@ -352,7 +351,7 @@ public slots: · 17 unmodified lines | ||
| 352 | 351 | * |
| 353 | 352 | * var notify = true; |
| 354 | 353 | * var animated = true; |
| 355 | − * var aspect = 1920 / 1080; | |
| 354 | + * var aspect = 1920 / 1080f; | |
| 356 | 355 | * var filename = ""; |
| 357 | 356 | * Window.takeSnapshot(notify, animated, aspect, filename); |
| 358 | 357 | */ |
| @@ -360,27 +359,23 @@ public slots: · 1 unmodified line | ||
| 360 | 359 | |
| 361 | 360 | /**jsdoc |
| 362 | 361 | * Takes a still snapshot of the current view from the secondary camera that can be set up through the {@link Render} API. |
| 363 | − * NOTE: to provide a non-default value - all previous parameters must be provided. | |
| 364 | 362 | * @function Window.takeSecondaryCameraSnapshot |
| 365 | − * @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'. | |
| 363 | + * @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". | |
| 366 | 364 | * If this parameter is <code>""</code> then the image will be saved as ".jpg". |
| 367 | 365 | * Otherwise, the image will be saved to this filename, with an appended ".jpg". |
| 368 | − * | |
| 369 | − * var filename = QString(); | |
| 370 | 366 | */ |
| 371 | 367 | void takeSecondaryCameraSnapshot(const QString& filename = QString()); |
| 372 | 368 | |
| 373 | 369 | /**jsdoc |
| 374 | − * Takes a 360 snapshot given a position of the secondary camera (which does not need to have been previously set up). | |
| 375 | − * @function Window.takeSecondaryCameraSnapshot | |
| 376 | − * @param {vec3} [cameraPosition] - The (x, y, z) position of the camera for the 360 snapshot | |
| 370 | + * Takes a 360° snapshot at a given position for the secondary camera. The secondary camera does not need to have been | |
| 371 | + * set up. | |
| 372 | + * @function Window.takeSecondaryCamera360Snapshot | |
| 373 | + * @param {Vec3} cameraPosition - The position of the camera for the snapshot. | |
| 377 | 374 | * @param {boolean} [cubemapOutputFormat=false] - If <code>true</code> then the snapshot is saved as a cube map image, |
| 378 | 375 | * otherwise is saved as an equirectangular image. |
| 379 | − * @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'. | |
| 376 | + * @param {string} [filename=""] - If this parameter is not supplied, the image will be saved as "hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS". | |
| 380 | 377 | * If this parameter is <code>""</code> then the image will be saved as ".jpg". |
| 381 | 378 | * Otherwise, the image will be saved to this filename, with an appended ".jpg". |
| 382 | − * | |
| 383 | − * var filename = QString(); | |
| 384 | 379 | */ |
| 385 | 380 | void takeSecondaryCamera360Snapshot(const glm::vec3& cameraPosition, const bool& cubemapOutputFormat = false, const QString& filename = QString()); |
| 386 | 381 | |
| @@ -612,7 +607,8 @@ signals: · 225 unmodified lines | ||
| 612 | 607 | void stillSnapshotTaken(const QString& pathStillSnapshot, bool notify); |
| 613 | 608 | |
| 614 | 609 | /**jsdoc |
| 615 | − * Triggered when a still equirectangular snapshot has been taken by calling {@link Window.takeSecondaryCamera360Snapshot|takeSecondaryCamera360Snapshot} | |
| 610 | + * Triggered when a still 360° snapshot has been taken by calling | |
| 611 | + * {@link Window.takeSecondaryCamera360Snapshot|takeSecondaryCamera360Snapshot}. | |
| 616 | 612 | * @function Window.snapshot360Taken |
| 617 | 613 | * @param {string} pathStillSnapshot - The path and name of the snapshot image file. |
| 618 | 614 | * @param {boolean} notify - The value of the <code>notify</code> parameter that {@link Window.takeSecondaryCamera360Snapshot|takeSecondaryCamera360Snapshot} |