Refactored MakeCurrent for EAGL and EAGL iOS drivers

Refactored Frame/Render buffers creation for an EGL Window Surface
Added partial support for destroying frame/renders buffers when Window
Surface is destroyed
Updated READMEs

Author: davidandreoletti

README-DEV.rst

@@ -3,18 +3,25 @@
 ## TODO LibEGL Bug Priority List:
 
     - None yet :)
+    - EAGLIOS_DestroyWindow must call windowsurfacehelper_destroyFrameBuffer
+    - EGLSurface backed with EAGLSurface and EAGLContext is inconsistent as soon as EAGLSurface and EAGLContext are not current.
+      The frame/color/depth buffers content lives in the EAGLContext. Should EAGLSharegroup bound to EAGLSurface be used to store frame/color/depth buffer ?
+      - Due to this bug, the framebuffer and related renderbuffers are leaking. See "EAGLIOS_DestroyWindow: Leak when destroying an EGL WindowSurface" msg
 
 ## TODO LibEGL Feature Priority List:
 
     - Add EGL_SWAP_BEHAVIOR_PRESERVED_BIT support. See EGL 1.4 Table 3.2
       Surface swap is EGL_BUFFER_DESTROYED for now ? See iOS support EGL_BUFFER_RETAINED via kEAGLDrawablePropertyRetainedBacking too
     - Add support for rotation. See EGL 1.4 - Section 3.9.1 Native Window Resizing
+    - Add support for Multisampling
 
 ## TODO Uncategorised List:
 
     - When are OpenGL ES buffers associated to EGLSurface deleted ?
     - Memory Leak: App starts with 8.5Mb without EGL. Running the demo + unit test consumes more 16Mb. When the demo stops, the memory consumption is higher than 8.5Mb. Some resources are not deleted
     - eglMakeCurrent(EGLDisplay dpy, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT) -> are FB/CB etc cleared ??? Should they ?
+    - Split Samples from UT Xcode projects 
+    - Can add support for GLKView (currently only CEAGLLayer supported) ?
 
 ## TODO Code Cleanup Priority List:
 

README.rst

@@ -139,7 +139,7 @@ is supported in this implementation.
 | eglQueryAPI                      | Supported              |         |
 | eglQueryContext                  | Supported              |         |
 | eglSurfaceAttrib                 | Planned                |         |
-| eglMakeCurrent                   | Partially supported    |         |
+| eglMakeCurrent                   | Partially supported    | `EGLSurface read` and `EGLSurface draw` must be the same |
 | eglGetCurrentContext             | Supported              |         |
 | eglGetCurrentSurface             | Supported              |         |
 | eglGetCurrentDisplay             | Supported              |         |

include/EGL/drivers/eagl/egl_eagl_driver.h

@@ -76,14 +76,22 @@ typedef void (*EAGLDESTROYCONTEXTPROC)( _EAGLWindow *dpy, struct EAGL_egl_contex
 
 /**
  *  Make EGLContext current a native EGL Context
- * \param EAGL_dpy
- * \param EAGL_conf
- * \param EAGL_ctx_shared
- * \param attrib_list
+ * \param dpy,
+ * \param EAGL_dsurf
+ * \param EAGL_rsurf
  * \param EAGL_ctx
+ * \param EAGL_odsurf
+ * \param EAGL_orsurf
+ * \param EAGL_octx
  *  \return Non NULL instance IFF initialization succeeded only.
  */
-typedef EGLBoolean (*EAGLMAKECURRENTPROC)(_EAGLWindow *dpy, struct EAGL_egl_surface* surface, struct EAGL_egl_context* ctx, _OpenGLESAPI* api);
+typedef EGLBoolean (*EAGLMAKECURRENTPROC)(_EAGLWindow *dpy,
+                                          struct EAGL_egl_surface* EAGL_dsurf,
+                                          struct EAGL_egl_surface* EAGL_rsurf,
+                                          struct EAGL_egl_context* EAGL_ctx,
+                                          struct EAGL_egl_surface *EAGL_odsurf,
+                                          struct EAGL_egl_surface *EAGL_orsurf,
+                                          struct EAGL_egl_context *EAGL_octx);
 /**
  *  Swap buffers
  * \param EAGL_dpy

include/EGL/drivers/eagl/ios/egl_eagl_ios_windowsurfacehelper.h

@@ -0,0 +1,41 @@
+/**************************************************************************
+ * MIT LICENSE
+ *
+ * Copyright (c) 2013-2014, David Andreoletti <http://davidandreoletti.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ **************************************************************************/
+
+#ifndef INCLUDE_EGL_DRIVERS_EAGL_IOS_EGL_EAGL_IOS_WINDOWSURFACEHELPER_H_
+#define INCLUDE_EGL_DRIVERS_EAGL_IOS_EGL_EAGL_IOS_WINDOWSURFACEHELPER_H_
+
+#include "EGL/drivers/eagl/opengles/opengles_ios.h"
+#include "EGL/drivers/eagl/egl_eagl_typedefs.h"
+#include "EGL/drivers/eagl/egl_eagl_context.h"
+
+bool windowsurfacehelper_createFrameBuffer(struct EAGL_egl_context* context, _EAGLSurface* surface,
+                                           _OpenGLESAPI* api);
+
+bool windowsurfacehelper_destroyFrameBuffer(struct EAGL_egl_context* context, _EAGLSurface* surface,
+                                           _OpenGLESAPI* api);
+
+bool windowsurfacehelper_makeFrameBufferCurrent(struct EAGL_egl_context* context, _EAGLSurface* surface,
+                                                _OpenGLESAPI* api);
+
+#endif  // INCLUDE_EGL_DRIVERS_EAGL_IOS_EGL_EAGL_IOS_WINDOWSURFACEHELPER_H_

proj/proj.ios/eglapi-core-lib/eglapi-core-lib.xcodeproj/project.pbxproj

@@ -122,6 +122,8 @@
 		F6794D0218DD7980002B8AFF /* EAGLIOSSurface.m in Sources */ = {isa = PBXBuildFile; fileRef = F6794CFE18DD7980002B8AFF /* EAGLIOSSurface.m */; };
 		F6794D0318DD7980002B8AFF /* EAGLIOSWindow.mm in Sources */ = {isa = PBXBuildFile; fileRef = F6794CFF18DD7980002B8AFF /* EAGLIOSWindow.mm */; };
 		F6794D0518DD802F002B8AFF /* egl_eagl_ios_config.h in Headers */ = {isa = PBXBuildFile; fileRef = F6794D0418DD802F002B8AFF /* egl_eagl_ios_config.h */; };
+		F6A2745618DE877B003304B2 /* egl_eagl_ios_windowsurfacehelper.h in Headers */ = {isa = PBXBuildFile; fileRef = F6A2745518DE877B003304B2 /* egl_eagl_ios_windowsurfacehelper.h */; };
+		F6A2745818DE87DE003304B2 /* egl_eagl_ios_windowsurfacehelper.m in Sources */ = {isa = PBXBuildFile; fileRef = F6A2745718DE87DE003304B2 /* egl_eagl_ios_windowsurfacehelper.m */; };
 		F6F66B48189F4FE1008636CE /* eglplatform.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = C7A86F78172B8B2300739D0D /* eglplatform.h */; };
 		F6F66B49189F57D3008636CE /* eglmesaext.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = C7A86F74172B8B2300739D0D /* eglmesaext.h */; };
 		F6F66B4B18A109BE008636CE /* OpenGLES.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C784D397171457B10086C69F /* OpenGLES.framework */; };
@@ -277,6 +279,8 @@
 		F6794CFE18DD7980002B8AFF /* EAGLIOSSurface.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = EAGLIOSSurface.m; path = ios/EAGLIOSSurface.m; sourceTree = "<group>"; };
 		F6794CFF18DD7980002B8AFF /* EAGLIOSWindow.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; name = EAGLIOSWindow.mm; path = ios/EAGLIOSWindow.mm; sourceTree = "<group>"; };
 		F6794D0418DD802F002B8AFF /* egl_eagl_ios_config.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = egl_eagl_ios_config.h; sourceTree = "<group>"; };
+		F6A2745518DE877B003304B2 /* egl_eagl_ios_windowsurfacehelper.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = egl_eagl_ios_windowsurfacehelper.h; sourceTree = "<group>"; };
+		F6A2745718DE87DE003304B2 /* egl_eagl_ios_windowsurfacehelper.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = egl_eagl_ios_windowsurfacehelper.m; path = ios/egl_eagl_ios_windowsurfacehelper.m; sourceTree = "<group>"; };
 		F6F8047618D556E9009F64C0 /* opengles3_ios.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = opengles3_ios.h; sourceTree = "<group>"; };
 		F6F8047818D55716009F64C0 /* opengles3_ios.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; path = opengles3_ios.c; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -312,6 +316,7 @@
 		C70713CE1821D5620020806A /* ios */ = {
 			isa = PBXGroup;
 			children = (
+				F6A2745718DE87DE003304B2 /* egl_eagl_ios_windowsurfacehelper.m */,
 				F6794CFC18DD7980002B8AFF /* egl_eagl_ios_driver.m */,
 				F6794CFD18DD7980002B8AFF /* EAGLIOSContext.m */,
 				F6794CFE18DD7980002B8AFF /* EAGLIOSSurface.m */,
@@ -574,6 +579,7 @@
 		F639689018AAF7110076C110 /* ios */ = {
 			isa = PBXGroup;
 			children = (
+				F6A2745518DE877B003304B2 /* egl_eagl_ios_windowsurfacehelper.h */,
 				F6794D0418DD802F002B8AFF /* egl_eagl_ios_config.h */,
 				F6794CF218DD7945002B8AFF /* egl_eagl_ios_driver.h */,
 				F6794CF318DD7945002B8AFF /* EAGLIOSContext.h */,
@@ -628,6 +634,7 @@
 				F61BCB2C18CF4E480015D31E /* opengles1_ios.h in Headers */,
 				C7A86F86172B8B2300739D0D /* egldisplay.h in Headers */,
 				C7A86F87172B8B2300739D0D /* egldriver.h in Headers */,
+				F6A2745618DE877B003304B2 /* egl_eagl_ios_windowsurfacehelper.h in Headers */,
 				C7A86F88172B8B2300739D0D /* eglext.h in Headers */,
 				C7A86F89172B8B2300739D0D /* eglglobals.h in Headers */,
 				C7A86F8A172B8B2300739D0D /* eglimage.h in Headers */,
@@ -798,6 +805,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				C709B8C21706818800FBCA04 /* eglapi.m in Sources */,
+				F6A2745818DE87DE003304B2 /* egl_eagl_ios_windowsurfacehelper.m in Sources */,
 				C7A86FA7172B8B3600739D0D /* eglapi.c in Sources */,
 				F6794D0118DD7980002B8AFF /* EAGLIOSContext.m in Sources */,
 				C7A86FA8172B8B3600739D0D /* eglarray.c in Sources */,

samples/samples.ios/Sample1/proj/proj.ios/Sample1/AppDelegate.mm

@@ -51,7 +51,7 @@ - (void) sample: (id) param {
     TestPlatform p = {0};
     iosInitializeWithDefault(&p);
     run_samples(&p);
-    run_unit_tests(&p);
+//    run_unit_tests(&p);
     iosDestroyWithDefault(&p);
 }
 

src/EGL/drivers/eagl/egl_eagl.m

@@ -297,7 +297,11 @@ static EGLBoolean _checkSurfaceAttribMatchConfigAttrib(_EGLSurface* surf, _EGLCo
         return EGL_FALSE;
     }
 
-    ret = EAGL_drv->MakeCurrent(EAGL_dpy->Window, EAGL_dsurf, EAGL_ctx, &EAGL_ctx->OpenGLESAPI);
+    struct EAGL_egl_surface *EAGL_odsurf = EAGL_egl_surface(old_dsurf);
+    struct EAGL_egl_surface *EAGL_orsurf = EAGL_egl_surface(old_rsurf);
+    struct EAGL_egl_context *EAGL_octx = EAGL_egl_context(old_ctx);
+    
+    ret = EAGL_drv->MakeCurrent(EAGL_dpy->Window, EAGL_dsurf, EAGL_rsurf, EAGL_ctx, EAGL_odsurf, EAGL_orsurf, EAGL_octx);
 
     if (ret) {
         if (_eglPutSurface(old_dsurf))