Expose QgsMapRendererCache for map canvases to PyQGIS

nyalldawson · nyalldawson · commit fe3818d37ea2 · 2023-03-28T15:05:41.000+10:00
diff --git a/python/gui/auto_generated/qgsmapcanvas.sip.in b/python/gui/auto_generated/qgsmapcanvas.sip.in
@@ -132,13 +132,21 @@ as a result of an ongoing canvas render) will not be returned, and instead ``Non
 %Docstring
 Set whether to cache images of rendered layers
 
+.. seealso:: :py:func:`isCachingEnabled`
+
+.. seealso:: :py:func:`cache`
+
 .. versionadded:: 2.4
 %End
 
     bool isCachingEnabled() const;
 %Docstring
 Check whether images of rendered layers are curerently being cached
 
+.. seealso:: :py:func:`setCachingEnabled`
+
+.. seealso:: :py:func:`cache`
+
 .. versionadded:: 2.4
 %End
 
@@ -149,6 +157,17 @@ Make sure to remove any rendered images from cache (does nothing if cache is not
 .. versionadded:: 2.4
 %End
 
+    QgsMapRendererCache *cache();
+%Docstring
+Returns the map renderer cache, if caching is enabled.
+
+.. seealso:: :py:func:`isCachingEnabled`
+
+.. seealso:: :py:func:`setCachingEnabled`
+
+.. versionadded:: 3.32
+%End
+
 
     void waitWhileRendering();
 %Docstring
diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp
@@ -652,6 +652,11 @@ void QgsMapCanvas::clearCache()
     mRenderedItemResults.reset();
 }
 
+QgsMapRendererCache *QgsMapCanvas::cache()
+{
+  return mCache;
+}
+
 void QgsMapCanvas::setParallelRenderingEnabled( bool enabled )
 {
   mUseParallelRendering = enabled;
diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h
@@ -187,12 +187,20 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView, public QgsExpressionContex
 
     /**
      * Set whether to cache images of rendered layers
+     *
+     * \see isCachingEnabled()
+     * \see cache()
+     *
      * \since QGIS 2.4
      */
     void setCachingEnabled( bool enabled );
 
     /**
      * Check whether images of rendered layers are curerently being cached
+     *
+     * \see setCachingEnabled()
+     * \see cache()
+     *
      * \since QGIS 2.4
      */
     bool isCachingEnabled() const;
@@ -203,6 +211,16 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView, public QgsExpressionContex
      */
     void clearCache();
 
+    /**
+     * Returns the map renderer cache, if caching is enabled.
+     *
+     * \see isCachingEnabled()
+     * \see setCachingEnabled()
+     *
+     * \since QGIS 3.32
+     */
+    QgsMapRendererCache *cache();
+
     /**
      * Cancel any rendering job, in a blocking way. Used for application closing.
      * \note not available in Python bindings

Original file line number	Diff line number	Diff line change
`@@ -652,6 +652,11 @@ void QgsMapCanvas::clearCache()`
`652`	`652`	`mRenderedItemResults.reset();`
`653`	`653`	`}`
`654`	`654`
	`655`	`+QgsMapRendererCache *QgsMapCanvas::cache()`
	`656`	`+{`
	`657`	`+ return mCache;`
	`658`	`+}`
	`659`	`+`
`655`	`660`	`void QgsMapCanvas::setParallelRenderingEnabled( bool enabled )`
`656`	`661`	`{`
`657`	`662`	`mUseParallelRendering = enabled;`