[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    playground/libs/kgllib/extras/kgllib
From:       Rivo Laks <rivolaks () hot ! ee>
Date:       2008-01-25 15:46:50
Message-ID: 1201276010.256097.15532.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 766323 by rivol:

Add some apidocs

 M  +10 -0     glwidget.h  


--- trunk/playground/libs/kgllib/extras/kgllib/glwidget.h #766322:766323
@@ -81,8 +81,18 @@
      * @li updates @ref fpsCounter
      * @li clears color and possibly depth buffer is @ref automaticClear is true
      * @li applies @ref camera
+     *
+     * Note that applications are preferred to use @ref render() instead. If
+     *  you do your OpenGL rendering in this method then some functionality
+     *  provided by this class will not work (e.g. fps display).
      **/
     virtual void paintGL();
+    /**
+     * Called from @ref paintGL() when the widget needs to be painted. This is
+     *  the method that you should reimplement to do your rendering.
+     * Base implementation does nothing, so you needn't call it from your
+     *  implementation.
+     **/
     virtual void render();
 
     /**
[prev in list] [next in list] [prev in thread] [next in thread]