Record whether each individual layer render job was completed success…

…fully Allows us to retrieve at a later stage whether or not the individual job was aborted early, or if it had already fully completed before the overall render operation was canceled.
qgis · Jan 28, 2021 · 2657da8 · 2657da8
1 parent a138921
commit 2657da8
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/src/core/qgsmaprenderercustompainterjob.cpp b/src/core/qgsmaprenderercustompainterjob.cpp
@@ -314,7 +314,7 @@ void QgsMapRendererCustomPainterJob::doRender()
         job.imageInitialized = true;
       }
 
-      job.renderer->render();
+      job.completed = job.renderer->render();
 
       job.renderingTime += layerTime.elapsed();
     }
@@ -385,7 +385,7 @@ void QgsMapRendererCustomPainterJob::doRender()
           job.imageInitialized = true;
         }
 
-        job.renderer->render();
+        job.completed = job.renderer->render();
 
         job.renderingTime += layerTime.elapsed();
       }

diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h
@@ -59,11 +59,21 @@ struct LayerRenderJob
   bool imageCanBeComposed() const;
 
   QgsMapLayerRenderer *renderer; // must be deleted
+
   QPainter::CompositionMode blendMode;
   double opacity;
   //! If TRUE, img already contains cached image from previous rendering
   bool cached;
   QgsWeakMapLayerPointer layer;
+
+  /**
+   * TRUE if the render job was successfully completed in its entirety (i.e. it was
+   * not canceled or aborted early).
+   *
+   * \since QGIS 3.18
+   */
+  bool completed = false;
+
   int renderingTime; //!< Time it took to render the layer in ms (it is -1 if not rendered or still rendering)
 
   /**

diff --git a/src/core/qgsmaprendererparalleljob.cpp b/src/core/qgsmaprendererparalleljob.cpp
@@ -359,7 +359,7 @@ void QgsMapRendererParallelJob::renderLayerStatic( LayerRenderJob &job )
 #ifdef SIMULATE_SLOW_RENDERER
     QThread::sleep( 1 );
 #endif
-    job.renderer->render();
+    job.completed = job.renderer->render();
   }
   catch ( QgsException &e )
   {

diff --git a/src/core/qgsmaprendererstagedrenderjob.cpp b/src/core/qgsmaprendererstagedrenderjob.cpp
@@ -117,7 +117,7 @@ bool QgsMapRendererStagedRenderJob::renderCurrentPart( QPainter *painter )
       job.imageInitialized = true;
     }
 
-    job.renderer->render();
+    job.completed = job.renderer->render();
 
     if ( job.img )
     {