From 0ca8545c203e91fc6669878a98148db2ffb82c1d Mon Sep 17 00:00:00 2001
From: SilverfishVR <53531160+SilverfishVR@users.noreply.github.com>
Date: Thu, 1 Sep 2022 22:23:07 +0200
Subject: [PATCH] Update API docs to reflect changes
---
.../src/scripting/WindowScriptingInterface.h | 22 +++++++++----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/interface/src/scripting/WindowScriptingInterface.h b/interface/src/scripting/WindowScriptingInterface.h
index 3b54112f6c..0167ec0035 100644
--- a/interface/src/scripting/WindowScriptingInterface.h
+++ b/interface/src/scripting/WindowScriptingInterface.h
@@ -334,9 +334,9 @@ public slots:
* dimensions is adjusted in order to match the aspect ratio.
* @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-<user
* name>-on-YYYY-MM-DD_HH-MM-SS".
- * Still images are saved in JPEG or PNG format according to the extension provided — ".jpg",
- * ".jpeg", or ".png" — or if not provided then in JPEG format with an extension of
- * ".jpg". Animated images are saved in GIF format.
+ * Still images are saved in JPEG, PNG or WEBP format according to the extension provided — ".jpg",
+ * ".jpeg", ".png", or ".webp" — or if not provided then in the format chosen in general settings,
+ * Default is PNG. Animated images are saved in GIF format.
*
* @example Using the snapshot function and signals.
* function onStillSnapshotTaken(path, notify) {
@@ -371,11 +371,11 @@ public slots:
* @function Window.takeSecondaryCameraSnapshot
* @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}
* signal.
- * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-<user
+ * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-<user
* name>-on-YYYY-MM-DD_HH-MM-SS".
- * Images are saved in JPEG or PNG format according to the extension provided — ".jpg",
- * ".jpeg", or ".png" — or if not provided then in JPEG format with an extension of
- * ".jpg".
+ * Still images are saved in JPEG, PNG or WEBP format according to the extension provided — ".jpg",
+ * ".jpeg", ".png", or ".webp" — or if not provided then in the format chosen in general settings,
+ * Default is PNG. Animated images are saved in GIF format.
*/
void takeSecondaryCameraSnapshot(const bool& notify = true, const QString& filename = QString());
@@ -390,11 +390,11 @@ public slots:
* otherwise it is saved as an equirectangular image.
* @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}
* signal.
- * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-<user
+ * @param {string} [filename=""] - If a filename is not provided, the image is saved as "overte-snap-by-<user
* name>-on-YYYY-MM-DD_HH-MM-SS".
- * Images are saved in JPEG or PNG format according to the extension provided — ".jpg",
- * ".jpeg", or ".png" — or if not provided then in JPEG format with an extension of
- * ".jpg".
+ * Still images are saved in JPEG, PNG or WEBP format according to the extension provided — ".jpg",
+ * ".jpeg", ".png", or ".webp" — or if not provided then in the format chosen in general settings,
+ * Default is PNG. Animated images are saved in GIF format.
*/
void takeSecondaryCamera360Snapshot(const glm::vec3& cameraPosition, const bool& cubemapOutputFormat = false, const bool& notify = true, const QString& filename = QString());