History

Update API docs to reflect changes

SilverfishVR committed 4 years ago

Commit 0ca85451 parent df56e041 file · +11 −11Browse files

Showing the changes to interface/src/scripting/WindowScriptingInterface.h (1 of 1 file). Show all

Unified · Split

interface/src/scripting/WindowScriptingInterface.h+11−11
@@ -334,9 +334,9 @@ public slots: · 333 unmodified lines
334 * dimensions is adjusted in order to match the aspect ratio.334 * dimensions is adjusted in order to match the aspect ratio.
335 * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-<user 335 * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-<user
336 * name>-on-YYYY-MM-DD_HH-MM-SS".336 * name>-on-YYYY-MM-DD_HH-MM-SS".
337 * <p>Still images are saved in JPEG or PNG format according to the extension provided &mdash; <code>".jpg"</code>, 337 * <p>Still images are saved in JPEG, PNG or WEBP format according to the extension provided &mdash; <code>".jpg"</code>,
338 * <code>".jpeg"</code>, or <code>".png"</code> &mdash; or if not provided then in JPEG format with an extension of 338 * <code>".jpeg"</code>, <code>".png"</code>, or <code>".webp"</code> &mdash; or if not provided then in the format chosen in general settings,
339 * <code>".jpg"</code>. Animated images are saved in GIF format.</p>339 * Default is PNG. Animated images are saved in GIF format.</p>
340 *340 *
341 * @example <caption>Using the snapshot function and signals.</caption>341 * @example <caption>Using the snapshot function and signals.</caption>
342 * function onStillSnapshotTaken(path, notify) {342 * function onStillSnapshotTaken(path, notify) {
@@ -371,11 +371,11 @@ public slots: · 28 unmodified lines
371 * @function Window.takeSecondaryCameraSnapshot371 * @function Window.takeSecondaryCameraSnapshot
372 * @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}372 * @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}
373 * signal.373 * signal.
374 * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-&lt;user374 * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-&lt;user
375 * name&gt;-on-YYYY-MM-DD_HH-MM-SS".375 * name&gt;-on-YYYY-MM-DD_HH-MM-SS".
376 * <p>Images are saved in JPEG or PNG format according to the extension provided &mdash; <code>".jpg"</code>,376 * <p>Still images are saved in JPEG, PNG or WEBP format according to the extension provided &mdash; <code>".jpg"</code>,
377 * <code>".jpeg"</code>, or <code>".png"</code> &mdash; or if not provided then in JPEG format with an extension of377 * <code>".jpeg"</code>, <code>".png"</code>, or <code>".webp"</code> &mdash; or if not provided then in the format chosen in general settings,
378 * <code>".jpg"</code>.</p>378 * Default is PNG. Animated images are saved in GIF format.</p>
379 */379 */
380 void takeSecondaryCameraSnapshot(const bool& notify = true, const QString& filename = QString());380 void takeSecondaryCameraSnapshot(const bool& notify = true, const QString& filename = QString());
381 381
@@ -390,11 +390,11 @@ public slots: · 8 unmodified lines
390 * otherwise it is saved as an equirectangular image.390 * otherwise it is saved as an equirectangular image.
391 * @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}391 * @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}
392 * signal.392 * signal.
393 * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-&lt;user393 * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-&lt;user
394 * name&gt;-on-YYYY-MM-DD_HH-MM-SS".394 * name&gt;-on-YYYY-MM-DD_HH-MM-SS".
395 * <p>Images are saved in JPEG or PNG format according to the extension provided &mdash; <code>".jpg"</code>,395 * <p>Still images are saved in JPEG, PNG or WEBP format according to the extension provided &mdash; <code>".jpg"</code>,
396 * <code>".jpeg"</code>, or <code>".png"</code> &mdash; or if not provided then in JPEG format with an extension of396 * <code>".jpeg"</code>, <code>".png"</code>, or <code>".webp"</code> &mdash; or if not provided then in the format chosen in general settings,
397 * <code>".jpg"</code>.</p>397 * Default is PNG. Animated images are saved in GIF format.</p>
398 */398 */
399 void takeSecondaryCamera360Snapshot(const glm::vec3& cameraPosition, const bool& cubemapOutputFormat = false, const bool& notify = true, const QString& filename = QString());399 void takeSecondaryCamera360Snapshot(const glm::vec3& cameraPosition, const bool& cubemapOutputFormat = false, const bool& notify = true, const QString& filename = QString());
400 400