QRenderCapture: add saveImage() to replace saveToFile()

QRenderCapture::saveToFile() does not return success/failure. Returning this
properly means we don't have to verify success somehow. So add a new method
called saveImage() to return the information, and deprecate saveToFile().

Change-Id: I7cf6639d90baa8bce8b90ee795d953a021de7978
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

2 files changed, 36 insertions, 1 deletions

diff --git a/src/render/framegraph/qrendercapture.cpp b/src/render/framegraph/qrendercapture.cpp
index e1b11e3e0..f3e5d53ee 100644
--- a/src/render/framegraph/qrendercapture.cpp
+++ b/src/render/framegraph/qrendercapture.cpp
@@ -110,9 +110,21 @@ namespace Qt3DRender {
  */
 
 /*!
+ * \qmlmethod bool Qt3D.Render::RenderCaptureReply::saveImage(fileName)
+ *
+ * Saves the render capture result as an image to \a fileName.
+ * Returns true if the image was successfully saved; otherwise returns false.
+ *
+ * \since 5.9
+ */
+
+/*!
  * \qmlmethod void Qt3D.Render::RenderCaptureReply::saveToFile(fileName)
+ * \deprecated
  *
  * Saves the render capture result as an image to \a fileName.
+ *
+ * Deprecated in 5.9. Use saveImage().
  */
 
 /*!
@@ -190,6 +202,25 @@ bool QRenderCaptureReply::isComplete() const
 
 /*!
  * Saves the render capture result as an image to \a fileName.
+ *
+ * Returns true if the image was successfully saved; otherwise returns false.
+ * \since 5.9
+ */
+bool QRenderCaptureReply::saveImage(const QString &fileName) const
+{
+    Q_D(const QRenderCaptureReply);
+    if (d->m_complete)
+    {
+        return d->m_image.save(fileName);
+    }
+    return false;
+}
+
+/*!
+ * \deprecated
+ * Saves the render capture result as an image to \a fileName.
+ *
+ * Deprecated in 5.9. Use saveImage().
  */
 void QRenderCaptureReply::saveToFile(const QString &fileName) const
 {
diff --git a/src/render/framegraph/qrendercapture.h b/src/render/framegraph/qrendercapture.h
index 698b2d8d4..5b768b593 100644
--- a/src/render/framegraph/qrendercapture.h
+++ b/src/render/framegraph/qrendercapture.h
@@ -60,7 +60,11 @@ public:
     Q_DECL_DEPRECATED int captureId() const;
     bool isComplete() const;
 
-    Q_INVOKABLE void saveToFile(const QString &fileName) const;
+    Q_INVOKABLE bool saveImage(const QString &fileName) const;
+#if QT_DEPRECATED_SINCE(5, 9)
+    // ### Qt 6: remove this
+    Q_DECL_DEPRECATED_X("Use saveImage instead") Q_INVOKABLE void saveToFile(const QString &fileName) const;
+#endif
 
 Q_SIGNALS:
     Q_DECL_DEPRECATED_X("Use completed instead") void completeChanged(bool isComplete);