qt5: Remove the use of deprecated QOpenGL module

QOpenGL module is marked as deprecated since a while now so it is time to remove its use from the Talipot codebase and promote the use of QOpenGL* classes directly integrated in the QtGui module. The big difference between QOpenGL and QtOpenGL from Qt5 is that all rendering is performed in framebuffer objects, there is no more direct rendering in the underlying os windows with its own OpenGL context. Talipot OpenGL rendering also follows that idiom, all renderings are performed offscreen using a shared OpenGL context. This also means that there is no more QGLWidget as viewport for QGraphicsView. Talipot OpenGL scene are now converted to QImage in order to display them using the default Qt raster rendering engine. This should fixes the numerous rendering glitches observed on MacOS. First thing observed after the migration is a consequent performance boost in OpenGL rendering when using an Intel GPU on a Linux host machine (especially when selecting elements, it is now 10 times faster on debian stable).
anlambert · Oct 21, 2019 · 1d1505a · 1d1505a · p-mary · Jan 3, 2020
1 parent 529b7a4
commit 1d1505a
Show file tree

Hide file tree

Showing 49 changed files with 357 additions and 780 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -141,7 +141,6 @@ jobs:
             - libcppunit-dev
             - binutils-dev
             - qt5-default
-            - libqt5opengl5-dev
             - libqt5webkit5-dev
             - libquazip5-dev
             - libglew-dev
@@ -202,7 +201,6 @@ jobs:
             - libcppunit-dev
             - binutils-dev
             - qt5-default
-            - libqt5opengl5-dev
             - libqt5webkit5-dev
             - libquazip5-dev
             - libglew-dev

diff --git a/cmake/FindQtX.cmake b/cmake/FindQtX.cmake
@@ -8,7 +8,6 @@
 UNSET(Qt5Core_FOUND CACHE)
 UNSET(Qt5Gui_FOUND CACHE)
 UNSET(Qt5Widgets_FOUND CACHE)
-UNSET(Qt5OpenGL_FOUND CACHE)
 UNSET(Qt5Xml_FOUND CACHE)
 UNSET(Qt5XmlPatterns_FOUND CACHE)
 UNSET(Qt5Network_FOUND CACHE)
@@ -28,7 +27,6 @@ UNSET(Qt5WebChannel_FOUND CACHE)
 UNSET(Qt5Core_DIR CACHE)
 UNSET(Qt5Gui_DIR CACHE)
 UNSET(Qt5Widgets_DIR CACHE)
-UNSET(Qt5OpenGL_DIR CACHE)
 UNSET(Qt5Xml_DIR CACHE)
 UNSET(Qt5XmlPatterns_DIR CACHE)
 UNSET(Qt5Network_DIR CACHE)
@@ -64,7 +62,6 @@ MACRO(SETUP_QT_LIBRARIES QtModule LIBRARIES)
 ENDMACRO(SETUP_QT_LIBRARIES)
 
 FIND_PACKAGE(Qt5Widgets 5.5 REQUIRED)
-FIND_PACKAGE(Qt5OpenGL 5.5 REQUIRED)
 FIND_PACKAGE(Qt5Network 5.5 REQUIRED)
 
 STRING(REGEX MATCH "[0-9]\\.[0-9]+" QT_VERSION "${Qt5Widgets_VERSION_STRING}")
@@ -116,7 +113,7 @@ ELSE()
   ENDIF()
 ENDIF()
 
-SET(QT_LIBRARIES ${Qt5Widgets_LIBRARIES} ${Qt5OpenGL_LIBRARIES} ${Qt5Network_LIBRARIES})
+SET(QT_LIBRARIES ${Qt5Widgets_LIBRARIES} ${Qt5Network_LIBRARIES})
 
 GET_FILENAME_COMPONENT(QT_CMAKE_DIR "${Qt5Core_DIR}" DIRECTORY)
 
@@ -171,10 +168,8 @@ SET(LAST_FOUND_QT_WEB_COMPONENT "${QT_WEB_COMPONENT}" CACHE INTERNAL "")
 
 MACRO(QTX_SET_INCLUDES_AND_DEFINITIONS)
   INCLUDE_DIRECTORIES(${Qt5Widgets_INCLUDE_DIRS})
-  INCLUDE_DIRECTORIES(${Qt5OpenGL_INCLUDE_DIRS})
   INCLUDE_DIRECTORIES(${Qt5Network_INCLUDE_DIRS})
   ADD_DEFINITIONS(${Qt5Widgets_DEFINITIONS})
-  ADD_DEFINITIONS(${Qt5OpenGL_DEFINITIONS})
   ADD_DEFINITIONS(${Qt5Network_DEFINITIONS})
 ENDMACRO()
 

diff --git a/library/talipot-gui/include/talipot/GlMainWidget.h b/library/talipot-gui/include/talipot/GlMainWidget.h
@@ -14,7 +14,7 @@
 #ifndef TALIPOT_GL_MAIN_WIDGET_H
 #define TALIPOT_GL_MAIN_WIDGET_H
 
-#include <QGLWidget>
+#include <QOpenGLWidget>
 #include <QWindow>
 
 #include <talipot/config.h>
@@ -52,10 +52,9 @@ class GlCompositeHierarchyManager;
  * After scene construction you can perform some operation on GlMainWidget :
  * - Selection with selectGlEntities()
  * - Image output with getImage(), createPicture()
- * - Texture output with createTexture()
- * - others operation on GlScene and QGlWidget
+ * - others operation on GlScene and QOpenGLWidget
  */
-class TLP_QT_SCOPE GlMainWidget : public QGLWidget {
+class TLP_QT_SCOPE GlMainWidget : public QOpenGLWidget {
   Q_OBJECT
 
 public:
@@ -126,26 +125,26 @@ class TLP_QT_SCOPE GlMainWidget : public QGLWidget {
    * @param a measure in screen coordinates specified as an integer
    * @return the converted measure in viewport coordinates as an integer
    */
-  int screenToViewport(int l) {
-    return l * windowHandle()->devicePixelRatio();
+  inline int screenToViewport(int l) {
+    return l * devicePixelRatio();
   }
 
   /**
    * @brief convert a screen measure into a viewport measure
    * @param a measure in screen coordinates specified as a double
    * @return the converted measure in viewport coordinates as a double
    */
-  double screenToViewport(double l) {
-    return l * windowHandle()->devicePixelRatio();
+  inline double screenToViewport(double l) {
+    return l * devicePixelRatio();
   }
 
   /**
    * @brief convert a screen point into a viewport point
    * @param a point in screen coordinates
    * @return the converted point in viewport coordinates
    */
-  Coord screenToViewport(const Coord &point) {
-    qreal dpr = windowHandle()->devicePixelRatio();
+  inline Coord screenToViewport(const Coord &point) {
+    qreal dpr = devicePixelRatio();
     return Coord(point.x() * dpr, point.y() * dpr);
   }
 
@@ -154,17 +153,17 @@ class TLP_QT_SCOPE GlMainWidget : public QGLWidget {
    * @param a measure in viewport coordinates specified as a double
    * @return the converted measure in screen coordinates as a double
    */
-  double viewportToScreen(double l) {
-    return l / windowHandle()->devicePixelRatio();
+  inline double viewportToScreen(double l) {
+    return l / devicePixelRatio();
   }
 
   /**
    * @brief convert a viewport point into a screen point
    * @param a point in viewport coordinates
    * @return the converted point in screen coordinates
    */
-  Coord viewportToScreen(const Coord &point) {
-    qreal dpr = windowHandle()->devicePixelRatio();
+  inline Coord viewportToScreen(const Coord &point) {
+    qreal dpr = devicePixelRatio();
     return Coord(point.x() / dpr, point.y() / dpr);
   }
 
@@ -176,14 +175,6 @@ class TLP_QT_SCOPE GlMainWidget : public QGLWidget {
   static void getTextureRealSize(int width, int height, int &textureRealWidth,
                                  int &textureRealHeight);
 
-  /**
-   * @brief Take a snapshot of the Widget and put it in an OpenGl texture
-   * @param width power of two number (for example 256)
-   * @param height power of two number (for example 256)
-   * You can use this texture with Tulip texture system
-   * @see GlTextureManager
-   */
-  QOpenGLFramebufferObject *createTexture(const std::string &textureName, int width, int height);
   /**
    * @brief Take a snapshot of the Widget and put it in a picture
    * @param width size
@@ -226,10 +217,11 @@ class TLP_QT_SCOPE GlMainWidget : public QGLWidget {
                       tlp::GlLayer *layer = nullptr);
 
   /**
-   * Extend makeCurrent function of QGLWidget to inform TextureManager and DisplayListManager of
-   * context changement
+   * Override default makeCurrent/doneCurrent behavior to activate deactivate
+   * adequate OpenGL context based on the QOpenGLWidget visibility
    */
-  virtual void makeCurrent();
+  void makeCurrent();
+  void doneCurrent();
 
   /**
    * Resize openGL view
@@ -270,43 +262,21 @@ class TLP_QT_SCOPE GlMainWidget : public QGLWidget {
    */
   bool keepScenePointOfViewOnSubgraphChanging() const;
 
-  /**
-   * @brief Specify if an advanced technique for better scene anti-aliasing has to be activated
-   *
-   * That option allows to obtain a better scene antialiasing through the use of offscreen rendering
-   * and sampling.
-   * The result rendering will look better while the performance will be slightly altered.
-   * That option is deactivated by default. Use it with caution as it could cause crashes with some
-   * buggy OpenGL drivers.
-   */
-  void setAdvancedAntiAliasing(bool advancedAntiAliasing) {
-    this->advancedAntiAliasing = advancedAntiAliasing;
-  }
-
-  /**
-   * Returns the advanced anti-aliasing technique state
-   */
-  bool advancedAntiAliasingActivated() const {
-    return advancedAntiAliasing;
-  }
-
 private:
-  void setupOpenGlContext();
-  void createRenderingStore(int width, int height);
-  void deleteRenderingStore();
+  void createFramebuffers(int width, int height);
+  void deleteFramebuffers();
 
   tlp::GlScene scene;
   QRegion _visibleArea;
   View *view;
   int widthStored;
   int heightStored;
-  unsigned char *renderingStore;
   bool frameBufferStored;
-  bool useFramebufferObject;
   QOpenGLFramebufferObject *glFrameBuf, *glFrameBuf2;
   static bool inRendering;
   bool keepPointOfViewOnSubgraphChanging;
   bool advancedAntiAliasing;
+  std::string sceneTextureId;
 
 public slots:
   /**
@@ -359,18 +329,6 @@ protected slots:
   void glResized(int w, int h);
 
   void graphChanged();
-
-public:
-  /**
-   * This function return the first QGLWidget created
-   * This function is use to share OpenGL context
-   */
-  static QGLWidget *getFirstQGLWidget();
-
-  static void clearFirstQGLWidget();
-
-private:
-  static QGLWidget *firstQGLWidget;
 };
 }
 

diff --git a/library/talipot-gui/include/talipot/GlOffscreenRenderer.h b/library/talipot-gui/include/talipot/GlOffscreenRenderer.h
@@ -24,12 +24,15 @@
 
 #include <QImage>
 
+class QOpenGLContext;
+class QOffscreenSurface;
 class QOpenGLFramebufferObject;
 
 namespace tlp {
 
 class GlSimpleEntity;
 class GlGraphComposite;
+class GlMainWidget;
 
 /**
  * @brief Render a scene in an image or in a texture.
@@ -109,6 +112,8 @@ class TLP_QT_SCOPE GlOffscreenRenderer {
 
   void renderExternalScene(GlScene *scene, const bool antialiased = false);
 
+  void renderGlMainWidget(GlMainWidget *glWidget, bool redrawNeeded = true);
+
   /**
    * @brief Generate a QImage from the scene. You need to call the renderScene function before this
    *function.
@@ -120,13 +125,20 @@ class TLP_QT_SCOPE GlOffscreenRenderer {
    **/
   GLuint getGLTexture(const bool generateMipMaps = false);
 
+  QOpenGLContext *getOpenGLContext();
+  void makeOpenGLContextCurrent();
+  void doneOpenGLContextCurrent();
+
 private:
   GlOffscreenRenderer();
 
   void initFrameBuffers(const bool antialiased);
 
   static GlOffscreenRenderer *instance;
 
+  QOpenGLContext *glContext;
+  QOffscreenSurface *offscreenSurface;
+
   unsigned int vPWidth, vPHeight;
   QOpenGLFramebufferObject *glFrameBuf, *glFrameBuf2;
   GlScene scene;

diff --git a/library/talipot-gui/include/talipot/QGlBufferManager.h b/library/talipot-gui/include/talipot/QGlBufferManager.h
diff --git a/library/talipot-gui/include/talipot/ViewActionsManager.h b/library/talipot-gui/include/talipot/ViewActionsManager.h
@@ -36,8 +36,7 @@ class TLP_QT_SCOPE ViewActionsManager : public QObject {
   QAction *_snapshotAction;
 
 public:
-  ViewActionsManager(View *view, GlMainWidget *widget, bool keepRatio,
-                     bool showAdvancedAntiAliasing = true);
+  ViewActionsManager(View *view, GlMainWidget *widget, bool keepRatio);
 
   // the function below must be called by the associated view
   // when overloading the View class corresponding method
@@ -48,7 +47,6 @@ protected slots:
   void redraw();
   void openSnapshotDialog();
   void setAntiAliasing(bool);
-  void setAdvancedAntiAliasing(bool);
 };
 }