From 614b51241130f1cb7a3eefb29d62b4b12befc02d Mon Sep 17 00:00:00 2001 From: Zach Fox Date: Mon, 18 Jun 2018 11:43:31 -0700 Subject: [PATCH] Add docs --- interface/src/scripting/WindowScriptingInterface.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/interface/src/scripting/WindowScriptingInterface.h b/interface/src/scripting/WindowScriptingInterface.h index 29eb6421e1..c1a4aa8635 100644 --- a/interface/src/scripting/WindowScriptingInterface.h +++ b/interface/src/scripting/WindowScriptingInterface.h @@ -319,6 +319,14 @@ public slots: * {@link Window.processingGifStarted|processingGifStarted} and {@link Window.processingGifCompleted|processingGifCompleted} * are emitted. The path to store the snapshots and the length of the animated GIF to capture are specified in Settings > * General > Snapshots. + * + * If user has supplied a specific filename for the snapshot: + * If the user's requested filename has a suffix that's contained within SUPPORTED_IMAGE_FORMATS, + * DON'T append ".jpg" to the filename. QT will save the image in the format associated with the + * filename's suffix. + * Otherwise, ".jpg" is appended to the user's requested filename so that the image is saved in JPG format. + * If the user hasn't supplied a specific filename for the snapshot: + * Save the snapshot in JPG format according to FILENAME_PATH_FORMAT * @function Window.takeSnapshot * @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken} * signal.