Showing the changes to interface/src/scripting/WindowScriptingInterface.h (1 of 1 file). Show all
Unified · Split
| @@ -325,6 +325,7 @@ public slots: · 324 unmodified lines | ||
| 325 | 325 | * {@link Window.stillSnapshotTaken|stillSnapshotTaken} is emitted; when a still image plus moving images are captured, |
| 326 | 326 | * {@link Window.processingGifStarted|processingGifStarted} and {@link Window.processingGifCompleted|processingGifCompleted} |
| 327 | 327 | * are emitted. The path to store the snapshots and the length of the animated GIF to capture are specified in Settings > |
| 328 | + * NOTE: to provide a non-default value - all previous parameters must be provided. | |
| 328 | 329 | * General > Snapshots. |
| 329 | 330 | * @function Window.takeSnapshot |
| 330 | 331 | * @param {boolean} notify=true - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken} |
| @@ -334,8 +335,10 @@ public slots: · 3 unmodified lines | ||
| 334 | 335 | * @param {number} aspectRatio=0 - The width/height ratio of the snapshot required. If the value is <code>0</code> the |
| 335 | 336 | * full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one of the |
| 336 | 337 | * dimensions is adjusted in order to match the aspect ratio. |
| 337 | − * @param {string} filename="" - If this value is not given, or is <code>""</code> then the image will be saved to this filename, with an appended ",jpg". | |
| 338 | − * otherwise, the image will be saved as 'hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS'. | |
| 338 | + * @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'. | |
| 339 | + * If this parameter is <code>""</code> then the image will be saved as ".jpg". | |
| 340 | + * Otherwise, the image will be saved to this filename, with an appended ".jpg". | |
| 341 | + * | |
| 339 | 342 | * @example <caption>Using the snapshot function and signals.</caption> |
| 340 | 343 | * function onStillSnapshotTaken(path, notify) { |
| 341 | 344 | * print("Still snapshot taken: " + path); |
| @@ -364,8 +367,11 @@ public slots: · 22 unmodified lines | ||
| 364 | 367 | |
| 365 | 368 | /**jsdoc |
| 366 | 369 | * Takes a still snapshot of the current view from the secondary camera that can be set up through the {@link Render} API. |
| 370 | + * NOTE: to provide a non-default value - all previous parameters must be provided. | |
| 367 | 371 | * @function Window.takeSecondaryCameraSnapshot |
| 368 | − * @param {string} filename="" - If this value is not given, or is <code>""</code> then the image will be saved to this filename, with an appended ".jpg". | |
| 372 | + * @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'. | |
| 373 | + * If this parameter is <code>""</code> then the image will be saved as ".jpg". | |
| 374 | + * Otherwise, the image will be saved to this filename, with an appended ".jpg". | |
| 369 | 375 | * |
| 370 | 376 | * var filename = QString(); |
| 371 | 377 | */ |