Skip to content
Permalink
Browse files

Add note about QgsMapCanvas::refresh() behavior

  • Loading branch information
wonder-sk committed Nov 15, 2014
1 parent fda637b commit 34e6a71327f79ac019212567ab7f27ed3fcd65ff
Showing with 4 additions and 0 deletions.
  1. +4 −0 doc/api_break.dox
@@ -21,6 +21,10 @@ This page tries to maintain a list with incompatible changes that happened in pr
\subsection qgis_api_break_mtr Multi-threaded Rendering

<ul>
<li>QgsMapCanvas::refresh() only schedules a map refresh (in near feature) and returns immediately - before it would do the drawing immediately
and return when the map is redrawn. A call to refresh() will have no effect if there is already a scheduled pending refresh.
When map canvas does actual rendering, it will first emit renderStarting() signal, once done it will emit mapCanvasRefreshed().
The client code doing refresh() in order to later save map image should be updated to use new QgsMapRendererJob API which is better suited for such task.
<li>QgsPluginLayer::draw() is now run in a background thread. It is recommended to implement newly added QgsPluginLayer::createMapRenderer()
method instead of using QgsPluginLayer::draw().
</ul>

0 comments on commit 34e6a71

Please sign in to comment.
You can’t perform that action at this time.