Mercurial > hg > svgui

diff layer/Colour3DPlotRenderer.h @ 1075:2e1d6c2ed3ee spectrogram-minor-refactor

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Another tiny bit
author Chris Cannam
date Wed, 29 Jun 2016 15:13:54 +0100
parents cb4c9fb37ddc
children e536dfc6b250
line wrap: on
line diff
--- a/layer/Colour3DPlotRenderer.h	Wed Jun 29 14:04:57 2016 +0100
+++ b/layer/Colour3DPlotRenderer.h	Wed Jun 29 15:13:54 2016 +0100
@@ -108,6 +108,12 @@
      *
      * If complete is true, the whole rect will be rendered and the
      * returned QRect will be equal to the passed QRect.
+     *
+     * If the model to render from is not ready, this will throw a
+     * std::logic_error exception. The model must be ready and the
+     * layer requesting the render must not be dormant in its view, so
+     * that the LayerGeometryProvider returns valid results; it is the
+     * caller's responsibility to ensure these.
      */
     RenderResult render(QPainter &paint,
                         QRect rect,