Merge lp:~jaytaoko/nux/nux-linaro-rev518-merge into lp:nux/2.0

[Jay Taoko]

* Merge linaro branch (lp:~linaro-graphics-wg/nux/nux-gles2-11.12 rev 518) with Nux trunk.
* This branch is adding support for a reference frame buffer in Nux. A Reference frame buffer allows Nux to restore a previously set FBO once it is done with its own rendering.

[David Barth (dbarth)]

Jay, can you document the test requirements for this change, and how much the code is already covered by existing tests?

[Alexandros Frantzis (afrantzis)]

The branch fails to build for gles2. Here is a fix:

=== modified file 'NuxGraphics/GraphicsDisplayX11.cpp'
--- NuxGraphics/GraphicsDisplayX11.cpp 2012-01-03 03:10:54 +0000
+++ NuxGraphics/GraphicsDisplayX11.cpp 2012-01-05 12:58:20 +0000
@@ -64,7 +64,9 @@
     , m_X11Screen(0)
     , m_ParentWindow(0)
     , m_GLCtx(0)
+#ifndef NUX_OPENGLES_20
     , glx_window_(0)
+#endif
     , m_NumVideoModes(0)
     , m_BorderPixel(0)
     , _x11_major(0)

=== modified file 'tools/unity_support_test.c'
--- tools/unity_support_test.c 2011-11-24 16:45:23 +0000
+++ tools/unity_support_test.c 2012-01-05 13:12:19 +0000
@@ -721,21 +721,26 @@
   // Open a X11 connection and get the root window.
   display = XOpenDisplay (display_name);

+#ifndef NUX_OPENGLES_20
   // Before doing anything with GLX, check that it is supported on the system.
   Bool glx_supported = False;
   int dummy0, dummy1;
   if (display)
     glx_supported = glXQueryExtension(display, &dummy0, &dummy1);
-
- if (!display || !glx_supported) {
- if (!display)
- results.error = strdup ("unable to open display");
- else
- results.error = strdup ("GLX is not available on the system");
-
- // exit with 5, to tell "it's not an error we should cache"
- results.result = 5;
- }
+#endif
+
+ if (!display) {
+ results.error = strdup ("unable to open display");
+ // exit with 5, to tell "it's not an error we should cache"
+ results.result = 5;
+ }
+#ifndef NUX_OPENGLES_20
+ else if (!glx_supported) {
+ results.error = strdup ("GLX is not available on the system");
+ // exit with 5, to tell "it's not an error we should cache"
+ results.result = 5;
+ }
+#endif
   else
   {
     screen = DefaultScreen (display);

[Jay Taoko (jaytaoko)]

The logic behind the reference framebuffer:
 - by default there is no reference frame buffer set and Nux render to the opengl back buffer.
 - When a reference frame buffer is set Nux does its rendering into the reference frame buffer texture.
 - it is up to the caller to display the texture from the reference frame buffer into the back buffer.

To test this, a sample program would set a reference frame buffer and have Nux render a single color quad all over the window. Then the program would dump the texture in the reference frame buffer to memory and compare a few texels with the color that was used.

[Mirco Müller (macslow)]

Approved.

review: Approve

[Unity Merger (unity-merger)]

Attempt to merge into lp:nux failed due to conflicts:

text conflict in configure.ac

[lp:~jaytaoko/nux/nux-linaro-rev518-merge]

535. By Jay Taoko on 2012-01-06

* Merged with Trunk

=== modified file 'Nux/WindowCompositor.cpp'
--- Nux/WindowCompositor.cpp	2012-01-04 00:47:59 +0000
+++ Nux/WindowCompositor.cpp	2012-01-06 18:46:23 +0000
@@ -41,6 +41,7 @@
 
   WindowCompositor::WindowCompositor(WindowThread *window_thread)
   : window_thread_(window_thread)  
+  , reference_fbo_(0)
   {
     m_FocusAreaWindow           = NULL;
     m_MenuWindow                = NULL;
@@ -1465,35 +1466,15 @@
         {
           m_FrameBufferObject->Deactivate();
 
-          // Enable this to render the drop shadow under windows: not perfect yet...
-          if (0)
-          {
-            graphics_engine.EmptyClippingRegion();
-            graphics_engine.SetOpenGLClippingRectangle(0, 0, window_width, window_height);
-            graphics_engine.SetViewport(0, 0, window_width, window_height);
-            graphics_engine.SetOrthographicProjectionMatrix(window_width, window_height);
-
-            Geometry shadow(window->GetBaseX(), window->GetBaseY(),
-                            window->GetBaseWidth(), window->GetBaseHeight());
-            //if(window->IsVisibleSizeGrip())
-            {
-              shadow.OffsetPosition(4, 4);
-              GetPainter().PaintShape(graphics_engine, shadow, color::Black,
-                                       eSHAPE_CORNER_SHADOW);
-            }
-//                    else
-//                    {
-//                        shadow.OffsetPosition(4, 4);
-//                        GetPainter().PaintShape(window_thread_->GetGraphicsEngine(), shadow, Color(0xFF000000), eSHAPE_CORNER_ROUND10_SHADOW);
-//                    }
-          }
-
-          CHECKGL( glDepthMask(GL_FALSE));
+          // Nux is done rendering a BaseWindow into a texture. The previous call to Deactivate
+          // has cancelled any opengl framebuffer object that was set.
+
+          CHECKGL(glDepthMask(GL_FALSE));
           {
             graphics_engine.ApplyClippingRectangle();
             PresentBufferToScreen(rt.color_rt, window->GetBaseX(), window->GetBaseY(), false, false, window->GetOpacity(), window->premultiply());
           }
-          CHECKGL( glDepthMask(GL_TRUE));
+          CHECKGL(glDepthMask(GL_TRUE));
           graphics_engine.GetRenderStates().SetBlend(false);
         }
 
@@ -1607,7 +1588,20 @@
     }
     else
     {
-      GetGraphicsDisplay()->GetGpuDevice()->DeactivateFrameBuffer();
+      if (GetWindowThread()->IsEmbeddedWindow() && reference_fbo_)
+      {
+        // In the context of Unity, we may want Nux to restore a specific fbo and render the
+        // BaseWindow texture into it. That fbo is called a reference framebuffer object. if a
+        // Reference framebuffer object is present, Nux sets it.
+        if (!RestoreReferenceFramebuffer())
+        {
+          nuxDebugMsg("[WindowCompositor::RenderTopViews] Setting the Reference fbo has failed.");
+        }
+      }
+      else
+      {
+        GetGraphicsDisplay()->GetGpuDevice()->DeactivateFrameBuffer();
+      }
     }
 
     window_thread_->GetGraphicsEngine().EmptyClippingRegion();
@@ -2272,5 +2266,87 @@
 
     return (*keyboard_grab_stack_.begin());
   }
+
+  void WindowCompositor::SetReferenceFramebuffer(unsigned int fbo_object, Geometry fbo_geometry)
+  {
+    reference_fbo_ = fbo_object;
+    reference_fbo_geometry_ = fbo_geometry;
+  }
+
+  bool WindowCompositor::RestoreReferenceFramebuffer()
+  {
+    // 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;
+  }
 }
 

=== modified file 'Nux/WindowCompositor.h'
--- Nux/WindowCompositor.h	2011-12-29 18:06:53 +0000
+++ Nux/WindowCompositor.h	2012-01-06 18:46:23 +0000
@@ -175,6 +175,23 @@
     //====================================
   
   public:
+    /*!
+        Set and external fbo to draw Nux BaseWindow into. This external fbo will be
+        restored after Nux completes it rendering. The external fbo is used only in embedded mode. \n
+        If the fbo_object parameter 0, then the reference fbo is invalid and will not be used.
+
+        @param fbo_object The opengl index of the fbo.
+        @param fbo_geometry The geometry of the fbo.
+    */
+    void SetReferenceFramebuffer(unsigned int fbo_object, Geometry fbo_geometry);
+
+    /*!
+        Bind the reference opengl framebuffer object.
+
+        @return True if no error was detected.
+    */
+    bool RestoreReferenceFramebuffer();
+
     ObjectPtr<IOpenGLFrameBufferObject>& GetWindowFrameBufferObject()
     {
       return m_FrameBufferObject;
@@ -561,6 +578,10 @@
     int m_TooltipX;
     int m_TooltipY;
 
+    //! The fbo to restore after Nux rendering in embedded mode.
+    unsigned int reference_fbo_;
+    Geometry reference_fbo_geometry_;
+
     //! Pointer grab stack.
     /*!
         The head of the list is the top of the stack.

=== modified file 'Nux/WindowThread.cpp'
--- Nux/WindowThread.cpp	2012-01-04 00:10:39 +0000
+++ Nux/WindowThread.cpp	2012-01-06 18:46:23 +0000
@@ -1425,6 +1425,15 @@
 
     graphics_display_->GetGpuDevice()->DeactivateFrameBuffer();
     IOpenGLShaderProgram::SetShaderTracking(false);
+
+    if (IsEmbeddedWindow() && window_compositor_->reference_fbo_)
+    {
+      // Restore the reference framebuffer
+      if (!window_compositor_->RestoreReferenceFramebuffer())
+      {
+        nuxDebugMsg("[WindowCompositor::RenderTopViews] Setting the Reference fbo has failed.");
+      }
+    }
   }
 
   int WindowThread::InstallEventInspector(EventInspector function, void* data)

=== modified file 'NuxGraphics/GraphicsDisplayX11.cpp'
--- NuxGraphics/GraphicsDisplayX11.cpp	2012-01-04 00:10:39 +0000
+++ NuxGraphics/GraphicsDisplayX11.cpp	2012-01-06 18:46:23 +0000
@@ -44,7 +44,9 @@
     , m_X11Screen(0)
     , m_ParentWindow(0)
     , m_GLCtx(0)
+#ifndef NUX_OPENGLES_20    
     , glx_window_(0)
+#endif
     , m_NumVideoModes(0)
     , m_BorderPixel(0)
     , _x11_major(0)

=== modified file 'configure.ac'
--- configure.ac	2012-01-06 16:55:41 +0000
+++ configure.ac	2012-01-06 18:46:23 +0000
@@ -22,7 +22,7 @@
 # The number format is : year/month/day
 # e.g.: december 5th, 2011 is: 20111205
 # So far there is no provision for more than one break in a day.
-m4_define([nux_abi_version], [20111213])
+m4_define([nux_abi_version], [20111214])
 
 m4_define([nux_version],
           [nux_major_version.nux_minor_version.nux_micro_version])

=== added directory 'tests/manual-tests'
=== added file 'tests/manual-tests/linaro-reference-fbo.txt'
--- tests/manual-tests/linaro-reference-fbo.txt	1970-01-01 00:00:00 +0000
+++ tests/manual-tests/linaro-reference-fbo.txt	2012-01-06 18:46:23 +0000
@@ -0,0 +1,8 @@
+
+The logic behind the reference framebuffer:
+ - by default there is no reference frame buffer set and Nux render to the opengl back buffer.
+ - When a reference frame buffer is set Nux does its rendering into the reference frame buffer texture.
+ - it is up to the caller to display the texture from the reference frame buffer into the back buffer.
+
+To test this, a sample program would set a reference frame buffer and have Nux render a single color quad all over the window. Then the program would dump the texture in the reference frame buffer to memory and compare a few texels with the color that was used.
+

=== modified file 'tools/unity_support_test.c'
--- tools/unity_support_test.c	2011-11-24 16:45:23 +0000
+++ tools/unity_support_test.c	2012-01-06 18:46:23 +0000
@@ -721,21 +721,27 @@
   // Open a X11 connection and get the root window.
   display = XOpenDisplay (display_name);
   
+#ifndef NUX_OPENGLES_20  
   // Before doing anything with GLX, check that it is supported on the system.
   Bool glx_supported = False;
   int dummy0, dummy1;
   if (display)
     glx_supported = glXQueryExtension(display, &dummy0, &dummy1);
 
-  if (!display || !glx_supported) {
-    if (!display)
-      results.error = strdup ("unable to open display");
-    else
-      results.error = strdup ("GLX is not available on the system");
+#endif
 
-    // exit with 5, to tell "it's not an error we should cache"
-    results.result = 5;
-  }
+  if (!display) {
+    results.error = strdup ("unable to open display");
+    // exit with 5, to tell "it's not an error we should cache"
+    results.result = 5;
+  }
+#ifndef NUX_OPENGLES_20
+  else if (!glx_supported) {
+    results.error = strdup ("GLX is not available on the system");
+    // exit with 5, to tell "it's not an error we should cache"
+    results.result = 5;
+  }
+#endif
   else
   {
     screen = DefaultScreen (display);