Merge lp:~smspillaz/nux/nux.3.0.fix_1036521 into lp:nux/3.0

[Sam Spilsbury]

Added a method to WindowCompositor RestoreMainFramebuffer which either restores the reference framebuffer or binds us to the backbuffer depending on what is available.

Added a method to WindowCompositor RestoreMainFramebuffer which either restores the reference framebuffer or binds us to the backbuffer depending on what is available. Test suite added.

[Daniel van Vugt (vanvugt)]

Seems to work. I've verified both bugs fixed (with the Unity fix).

We could do better than giant switch statements, but they were pre-existing...

review: Approve

[Sam Spilsbury (smspillaz)]

On Wed, 19 Sep 2012, Daniel van Vugt wrote:

> Review: Approve
>
> Seems to work. I've verified both bugs fixed (with the Unity fix).
>
> We could do better than giant switch statements, but they were pre-existing...

I'd like to say this too, however its really required for the operation of
framebuffer objects

> --
> https://code.launchpad.net/~smspillaz/nux/nux.3.0.fix_1036521/+merge/125106
> You are the owner of lp:~smspillaz/nux/nux.3.0.fix_1036521.
>

=== modified file 'Nux/WindowCompositor.cpp'
--- Nux/WindowCompositor.cpp	2012-09-18 18:22:26 +0000
+++ Nux/WindowCompositor.cpp	2012-09-19 06:37:18 +0000
@@ -2277,80 +2277,104 @@
     reference_fbo_geometry_ = fbo_geometry;
   }
 
+  namespace
+  {
+    bool CheckExternalFramebufferStatus (GLenum binding)
+    {
+      bool ok = false;
+      // Nux does some sanity checks to make sure that the FBO is in good condition.
+      GLenum status;
+      status = glCheckFramebufferStatusEXT(binding);
+      CHECKGL_MSG(glCheckFramebufferStatusEXT);
+
+      switch(status)
+      {
+        case GL_FRAMEBUFFER_COMPLETE_EXT: // Everything's OK
+          ok = true;
+          break;
+        case GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT:
+          nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT");
+          ok = false;
+          break;
+        case GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT:
+          nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT");
+          ok = false;
+          break;
+          // See issue(87) of http://www.opengl.org/registry/specs/EXT/framebuffer_object.txt
+          //  case GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT:
+          //      nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT");
+          //      ok = false;
+          //      break;
+        case GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT:
+          nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT");
+          ok = false;
+          break;
+  #ifndef NUX_OPENGLES_20
+        case GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT:
+          nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT");
+          ok = false;
+          break;
+        case GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT:
+          nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT");
+          ok = false;
+          break;
+        case GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT:
+          nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT");
+          ok = false;
+          break;
+  #endif
+        //  case GL_FRAMEBUFFER_STATUS_ERROR_EXT:
+        //      nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_STATUS_ERROR_EXT");
+        //      ok = false;
+        //      break;
+        case GL_FRAMEBUFFER_UNSUPPORTED_EXT:
+          nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_UNSUPPORTED_EXT");
+          ok = false;
+          break;
+        default:
+          nuxError("[GLFramebufferObject::IsValid] Unknown ERROR");
+          ok = false;
+      }
+
+      return ok;
+    }
+
+    void SetReferenceFramebufferViewport (const nux::Geometry &reference_fbo_geometry_)
+    {
+      CHECKGL(glViewport(reference_fbo_geometry_.x,
+        reference_fbo_geometry_.y,
+        reference_fbo_geometry_.width,
+        reference_fbo_geometry_.height));
+    }
+  }
+
   bool WindowCompositor::RestoreReferenceFramebuffer()
   {
+    if (!reference_fbo_)
+      return false;
+
     // It is assumed that the reference fbo contains valid textures.
     // Nux does the following:
     //    - Bind the reference fbo (reference_fbo_)
     //    - Call glDrawBuffer with GL_COLOR_ATTACHMENT0
     //    - Set the opengl viewport size (reference_fbo_geometry_)
 
-    bool ok = false;
-
     CHECKGL(glBindFramebufferEXT(GL_FRAMEBUFFER_EXT, reference_fbo_));
 #ifndef NUX_OPENGLES_20
     CHECKGL(glDrawBuffer(GL_COLOR_ATTACHMENT0));
-#endif
-    CHECKGL(glViewport(reference_fbo_geometry_.x,
-      reference_fbo_geometry_.y,
-      reference_fbo_geometry_.width,
-      reference_fbo_geometry_.height));
-
-    // Nux does some sanity checks to make sure that the FBO is in good condition.
-    GLenum status;
-    status = glCheckFramebufferStatusEXT(GL_FRAMEBUFFER_EXT);
-    CHECKGL_MSG(glCheckFramebufferStatusEXT);
-
-    switch(status)
-    {
-      case GL_FRAMEBUFFER_COMPLETE_EXT: // Everything's OK
-        ok = true;
-        break;
-      case GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT:
-        nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT");
-        ok = false;
-        break;
-      case GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT:
-        nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT");
-        ok = false;
-        break;
-        // See issue(87) of http://www.opengl.org/registry/specs/EXT/framebuffer_object.txt
-        //  case GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT:
-        //      nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT");
-        //      ok = false;
-        //      break;
-      case GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT:
-        nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT");
-        ok = false;
-        break;
-#ifndef NUX_OPENGLES_20
-      case GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT:
-        nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT");
-        ok = false;
-        break;
-      case GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT:
-        nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT");
-        ok = false;
-        break;
-      case GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT:
-        nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT");
-        ok = false;
-        break;
-#endif
-      //  case GL_FRAMEBUFFER_STATUS_ERROR_EXT:
-      //      nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_STATUS_ERROR_EXT");
-      //      ok = false;
-      //      break;
-      case GL_FRAMEBUFFER_UNSUPPORTED_EXT:
-        nuxError("[GLFramebufferObject::IsValid] GL_FRAMEBUFFER_UNSUPPORTED_EXT");
-        ok = false;
-        break;
-      default:
-        nuxError("[GLFramebufferObject::IsValid] Unknown ERROR");
-        ok = false;
-    }    
-
-    return ok;
+    CHECKGL(glReadBuffer(GL_COLOR_ATTACHMENT0));
+#endif
+
+    SetReferenceFramebufferViewport (reference_fbo_geometry_);
+
+    return CheckExternalFramebufferStatus (GL_FRAMEBUFFER_EXT);
+  }
+
+  void WindowCompositor::RestoreMainFramebuffer()
+  {
+    // This is a bit inefficient as we unbind and then rebind
+    nux::GetGraphicsDisplay()->GetGpuDevice()->DeactivateFrameBuffer ();
+    RestoreReferenceFramebuffer ();
   }
 
 #ifdef NUX_GESTURES_SUPPORT

=== modified file 'Nux/WindowCompositor.h'
--- Nux/WindowCompositor.h	2012-09-18 18:22:26 +0000
+++ Nux/WindowCompositor.h	2012-09-19 06:37:18 +0000
@@ -216,6 +216,7 @@
         @return True if no error was detected.
     */
     bool RestoreReferenceFramebuffer();
+    void RestoreMainFramebuffer();
 
     ObjectPtr<IOpenGLFrameBufferObject>& GetWindowFrameBufferObject()
     {

=== modified file 'tests/gtest-nux-windowcompositor.cpp'
--- tests/gtest-nux-windowcompositor.cpp	2012-09-18 18:22:26 +0000
+++ tests/gtest-nux-windowcompositor.cpp	2012-09-19 06:37:18 +0000
@@ -143,6 +143,86 @@
   boost::shared_ptr<nux::WindowThread> wnd_thread;
 };
 
+namespace
+{
+  class ReferenceFramebuffer
+  {
+    public:
+
+      ReferenceFramebuffer ()
+      {
+        glGenFramebuffersEXT (1, &fboName);
+        glGenRenderbuffersEXT (1, &rbName);
+
+        glBindRenderbufferEXT (GL_RENDERBUFFER_EXT, rbName);
+        glRenderbufferStorageEXT (GL_RENDERBUFFER_EXT, GL_RGBA8_EXT, 300, 200);
+        glBindFramebufferEXT (GL_FRAMEBUFFER_EXT, fboName);
+        glFramebufferRenderbufferEXT (GL_FRAMEBUFFER_EXT, GL_COLOR_ATTACHMENT0_EXT, GL_RENDERBUFFER_EXT, rbName);
+      }
+
+      ~ReferenceFramebuffer ()
+      {
+        glBindFramebufferEXT (GL_FRAMEBUFFER_EXT, 0);
+        glDeleteRenderbuffers (1, &rbName);
+        glDeleteRenderbuffers (1, &fboName);
+      }
+
+    GLuint fboName, rbName;
+  };
+}
+TEST_F(TestWindowCompositor, TestRestoreReferenceFramebufferDirect)
+{
+  ReferenceFramebuffer reference;
+  GLint  fbBinding;
+
+  glGetIntegerv (GL_FRAMEBUFFER_BINDING_EXT, &fbBinding);
+
+  ASSERT_EQ (fbBinding, reference.fboName);
+
+  wnd_thread->GetWindowCompositor().SetReferenceFramebuffer(fbBinding, nux::Geometry (0, 0, 300, 200));
+
+  ASSERT_TRUE (wnd_thread->GetWindowCompositor().RestoreReferenceFramebuffer());
+  glGetIntegerv (GL_FRAMEBUFFER_BINDING_EXT, &fbBinding);
+  ASSERT_EQ (fbBinding, reference.fboName);
+}
+
+TEST_F(TestWindowCompositor, TestRestoreReferenceFramebufferThroughRestoreMain)
+{
+  ReferenceFramebuffer reference;
+  GLint  fbBinding;
+
+  glGetIntegerv (GL_FRAMEBUFFER_BINDING_EXT, &fbBinding);
+
+  ASSERT_EQ (fbBinding, reference.fboName);
+
+  wnd_thread->GetWindowCompositor().SetReferenceFramebuffer(fbBinding, nux::Geometry (0, 0, 300, 200));
+  wnd_thread->GetWindowCompositor().RestoreMainFramebuffer();
+  glGetIntegerv (GL_FRAMEBUFFER_BINDING_EXT, &fbBinding);
+  ASSERT_EQ (fbBinding, reference.fboName);
+}
+
+TEST_F(TestWindowCompositor, TestNoRestoreReferenceFramebufferDirectIfNoReferenceFramebuffer)
+{
+  GLint fbBinding;
+  ASSERT_FALSE (wnd_thread->GetWindowCompositor().RestoreReferenceFramebuffer());
+  glGetIntegerv (GL_FRAMEBUFFER_BINDING_EXT, &fbBinding);
+  ASSERT_EQ (fbBinding, 0);
+}
+
+TEST_F(TestWindowCompositor, TestRestoreBackbufferThroughRestoreMain)
+{
+  ReferenceFramebuffer reference;
+  GLint  fbBinding;
+
+  glGetIntegerv (GL_FRAMEBUFFER_BINDING_EXT, &fbBinding);
+
+  ASSERT_EQ (fbBinding, reference.fboName);
+
+  wnd_thread->GetWindowCompositor().RestoreMainFramebuffer();
+  glGetIntegerv (GL_FRAMEBUFFER_BINDING_EXT, &fbBinding);
+  ASSERT_EQ (fbBinding, 0);
+}
+
 TEST_F(TestWindowCompositor, TestSetKeyFocusArea)
 {
   nux::TestView* test_view0 = new nux::TestView();