We are currently migrating Bugzilla to GitHub issues.
Any changes made to the bug tracker now will be lost, so please do not post new bugs or make changes to them.
When we're done, all bug URLs will redirect to their equivalent location on the new bug tracker.

patch to augment SDL_GetError() output from failed EGL calls

SDL_EGL_error_text_augmentation.patch (text/plain), 10.87 KB, created by David Ludwig on 2016-12-29 17:06:16 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: David Ludwig

Created: 2016-12-29 17:06:16 UTC

Size: 10.87 KB

patch

obsolete

># HG changeset patch
># User David Ludwig <dludwig@pobox.com>
># Date 1483030158 18000
>#      Thu Dec 29 11:49:18 2016 -0500
># Node ID af33295c6d0749fb94c5b5a5ada4638778a531f6
># Parent  c3695a400046f4a7637aeec6e7a40553ad738e00
>improved SDL_GetError() output generated by EGL code
>
>This change attempts to report the EGL error codes generated by SDL's calls
>into EGL, along with the name of the EGL function that failed.
>
>diff -r c3695a400046 -r af33295c6d07 src/video/SDL_egl.c
>--- a/src/video/SDL_egl.c	Wed Dec 28 20:11:29 2016 +0100
>+++ b/src/video/SDL_egl.c	Thu Dec 29 11:49:18 2016 -0500
>@@ -74,7 +74,42 @@
> { \
>     return SDL_SetError("Could not retrieve EGL function " #NAME); \
> }
>-    
>+
>+static const char * SDL_EGL_GetErrorName(EGLint eglErrorCode)
>+{
>+#define SDL_EGL_ERROR_TRANSLATE(e) case e: return #e;
>+    switch (eglErrorCode) {
>+        SDL_EGL_ERROR_TRANSLATE(EGL_SUCCESS);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_NOT_INITIALIZED);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_ACCESS);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_ALLOC);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_ATTRIBUTE);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_CONTEXT);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_CONFIG);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_CURRENT_SURFACE);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_DISPLAY);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_SURFACE);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_MATCH);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_PARAMETER);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_NATIVE_PIXMAP);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_BAD_NATIVE_WINDOW);
>+        SDL_EGL_ERROR_TRANSLATE(EGL_CONTEXT_LOST);
>+    }
>+    return "";
>+}
>+
>+int SDL_EGL_SetErrorEx(const char * message, const char * eglFunctionName, EGLint eglErrorCode)
>+{
>+    const char * errorText = SDL_EGL_GetErrorName(eglErrorCode);
>+    char altErrorText[32];
>+    if (errorText[0] == '\0') {
>+        /* An unknown-to-SDL error code was reported.  Report its hexadecimal value, instead of its name. */
>+        SDL_snprintf(altErrorText, SDL_arraysize(altErrorText), "0x%x", (unsigned int)eglErrorCode);
>+        errorText = altErrorText;
>+    }
>+    return SDL_SetError("%s (call to %s failed, reporting an error of %s)", message, eglFunctionName, errorText);
>+}
>+
> /* EGL implementation of SDL OpenGL ES support */
> #ifdef EGL_KHR_create_context        
> static int SDL_EGL_HasExtension(_THIS, const char *ext)
>@@ -265,7 +300,8 @@
>     LOAD_FUNC(eglWaitGL);
>     LOAD_FUNC(eglBindAPI);
>     LOAD_FUNC(eglQueryString);
>-    
>+    LOAD_FUNC(eglGetError);
>+
> #if !defined(__WINRT__)
>     _this->egl_data->egl_display = _this->egl_data->eglGetDisplay(native_display);
>     if (!_this->egl_data->egl_display) {
>@@ -378,7 +414,7 @@
>         configs, SDL_arraysize(configs),
>         &found_configs) == EGL_FALSE ||
>         found_configs == 0) {
>-        return SDL_SetError("Couldn't find matching EGL config");
>+        return SDL_EGL_SetError("Couldn't find matching EGL config", "eglChooseConfig");
>     }
> 
>     /* eglChooseConfig returns a number of configurations that match or exceed the requested attribs. */
>@@ -497,15 +533,23 @@
>                                       share_context, attribs);
> 
>     if (egl_context == EGL_NO_CONTEXT) {
>-        SDL_SetError("Could not create EGL context");
>+        SDL_EGL_SetError("Could not create EGL context", "eglCreateContext");
>         return NULL;
>     }
> 
>     _this->egl_data->egl_swapinterval = 0;
> 
>     if (SDL_EGL_MakeCurrent(_this, egl_surface, egl_context) < 0) {
>+        /* Save the SDL error set by SDL_EGL_MakeCurrent */
>+        char errorText[1024];
>+        SDL_strlcpy(errorText, SDL_GetError(), SDL_arraysize(errorText));
>+
>+        /* Delete the context, which may alter the value returned by SDL_GetError() */
>         SDL_EGL_DeleteContext(_this, egl_context);
>-        SDL_SetError("Could not make EGL context current");
>+
>+        /* Restore the SDL error */
>+        SDL_SetError("%s", errorText);
>+
>         return NULL;
>     }
> 
>@@ -529,7 +573,7 @@
>     } else {
>         if (!_this->egl_data->eglMakeCurrent(_this->egl_data->egl_display,
>             egl_surface, egl_surface, egl_context)) {
>-            return SDL_SetError("Unable to make EGL context current");
>+            return SDL_EGL_SetError("Unable to make EGL context current", "eglMakeCurrent");
>         }
>     }
>       
>@@ -551,7 +595,7 @@
>         return 0;
>     }
>     
>-    return SDL_SetError("Unable to set the EGL swap interval");
>+    return SDL_EGL_SetError("Unable to set the EGL swap interval", "eglSwapInterval");
> }
> 
> int
>@@ -569,7 +613,7 @@
> SDL_EGL_SwapBuffers(_THIS, EGLSurface egl_surface)
> {
>     if (!_this->egl_data->eglSwapBuffers(_this->egl_data->egl_display, egl_surface)) {
>-        return SDL_SetError("eglSwapBuffers() failed");
>+        return SDL_EGL_SetError("unable to show color buffer in an OS-native window", "eglSwapBuffers");
>     }
>     return 0;
> }
>@@ -594,6 +638,8 @@
> EGLSurface *
> SDL_EGL_CreateSurface(_THIS, NativeWindowType nw) 
> {
>+    EGLSurface * surface;
>+
>     if (SDL_EGL_ChooseConfig(_this) != 0) {
>         return EGL_NO_SURFACE;
>     }
>@@ -612,10 +658,14 @@
>     }
> #endif    
>     
>-    return _this->egl_data->eglCreateWindowSurface(
>+    surface = _this->egl_data->eglCreateWindowSurface(
>             _this->egl_data->egl_display,
>             _this->egl_data->egl_config,
>             nw, NULL);
>+    if (surface == EGL_NO_SURFACE) {
>+        SDL_EGL_SetError("unable to create an EGL window surface", "eglCreateWindowSurface");
>+    }
>+    return surface;
> }
> 
> void
>diff -r c3695a400046 -r af33295c6d07 src/video/SDL_egl_c.h
>--- a/src/video/SDL_egl_c.h	Wed Dec 28 20:11:29 2016 +0100
>+++ b/src/video/SDL_egl_c.h	Thu Dec 29 11:49:18 2016 -0500
>@@ -79,6 +79,8 @@
>     
>     EGLBoolean(EGLAPIENTRY *eglBindAPI)(EGLenum);
> 
>+    EGLint(EGLAPIENTRY *eglGetError)(void);
>+
> } SDL_EGL_VideoData;
> 
> /* OpenGLES functions */
>@@ -98,6 +100,10 @@
> extern int SDL_EGL_MakeCurrent(_THIS, EGLSurface egl_surface, SDL_GLContext context);
> extern int SDL_EGL_SwapBuffers(_THIS, EGLSurface egl_surface);
> 
>+/* SDL Error-reporting */
>+extern int SDL_EGL_SetErrorEx(const char * message, const char * eglFunctionName, EGLint eglErrorCode);
>+#define SDL_EGL_SetError(message, eglFunctionName) SDL_EGL_SetErrorEx(message, eglFunctionName, _this->egl_data->eglGetError())
>+
> /* A few of useful macros */
> 
> #define SDL_EGL_SwapWindow_impl(BACKEND) int \
>diff -r c3695a400046 -r af33295c6d07 src/video/winrt/SDL_winrtopengles.cpp
>--- a/src/video/winrt/SDL_winrtopengles.cpp	Wed Dec 28 20:11:29 2016 +0100
>+++ b/src/video/winrt/SDL_winrtopengles.cpp	Thu Dec 29 11:49:18 2016 -0500
>@@ -28,6 +28,7 @@
> extern "C" {
> #include "SDL_winrtopengles.h"
> #include "SDL_loadso.h"
>+#include "../SDL_egl_c.h"
> }
> 
> /* Windows includes */
>@@ -87,11 +88,11 @@
>         Microsoft::WRL::ComPtr<IUnknown> cpp_display = video_data->winrtEglWindow;
>         _this->egl_data->egl_display = ((eglGetDisplay_Old_Function)_this->egl_data->eglGetDisplay)(cpp_display);
>         if (!_this->egl_data->egl_display) {
>-            return SDL_SetError("Could not get Windows 8.0 EGL display");
>+            return SDL_EGL_SetError("Could not get Windows 8.0 EGL display", "eglGetDisplay");
>         }
> 
>         if (_this->egl_data->eglInitialize(_this->egl_data->egl_display, NULL, NULL) != EGL_TRUE) {
>-            return SDL_SetError("Could not initialize Windows 8.0 EGL");
>+            return SDL_EGL_SetError("Could not initialize Windows 8.0 EGL", "eglInitialize");
>         }
>     } else {
>         /* Declare some ANGLE/EGL initialization property-sets, as suggested by
>@@ -132,7 +133,7 @@
>          */
>         eglGetPlatformDisplayEXT_Function eglGetPlatformDisplayEXT = (eglGetPlatformDisplayEXT_Function)_this->egl_data->eglGetProcAddress("eglGetPlatformDisplayEXT");
>         if (!eglGetPlatformDisplayEXT) {
>-            return SDL_SetError("Could not retrieve ANGLE/WinRT display function(s)");
>+            return SDL_EGL_SetError("Could not retrieve ANGLE/WinRT display function(s)", "eglGetProcAddress");
>         }
> 
> #if (WINAPI_FAMILY != WINAPI_FAMILY_PHONE_APP)
>@@ -141,7 +142,7 @@
>          */
>         _this->egl_data->egl_display = eglGetPlatformDisplayEXT(EGL_PLATFORM_ANGLE_ANGLE, EGL_DEFAULT_DISPLAY, defaultDisplayAttributes);
>         if (!_this->egl_data->egl_display) {
>-            return SDL_SetError("Could not get 10_0+ EGL display");
>+            return SDL_EGL_SetError("Could not get EGL display for Direct3D 10_0+", "eglGetPlatformDisplayEXT");
>         }
> 
>         if (_this->egl_data->eglInitialize(_this->egl_data->egl_display, NULL, NULL) != EGL_TRUE)
>@@ -153,7 +154,7 @@
>              */
>             _this->egl_data->egl_display = eglGetPlatformDisplayEXT(EGL_PLATFORM_ANGLE_ANGLE, EGL_DEFAULT_DISPLAY, fl9_3DisplayAttributes);
>             if (!_this->egl_data->egl_display) {
>-                return SDL_SetError("Could not get 9_3 EGL display");
>+                return SDL_EGL_SetError("Could not get EGL display for Direct3D 9_3", "eglGetPlatformDisplayEXT");
>             }
> 
>             if (_this->egl_data->eglInitialize(_this->egl_data->egl_display, NULL, NULL) != EGL_TRUE) {
>@@ -162,11 +163,11 @@
>                  */
>                 _this->egl_data->egl_display = eglGetPlatformDisplayEXT(EGL_PLATFORM_ANGLE_ANGLE, EGL_DEFAULT_DISPLAY, warpDisplayAttributes);
>                 if (!_this->egl_data->egl_display) {
>-                    return SDL_SetError("Could not get WARP EGL display");
>+                    return SDL_EGL_SetError("Could not get EGL display for Direct3D WARP", "eglGetPlatformDisplayEXT");
>                 }
> 
>                 if (_this->egl_data->eglInitialize(_this->egl_data->egl_display, NULL, NULL) != EGL_TRUE) {
>-                    return SDL_SetError("Could not initialize WinRT 8.x+ EGL");
>+                    return SDL_EGL_SetError("Could not initialize WinRT 8.x+ EGL", "eglInitialize");
>                 }
>             }
>         }
>diff -r c3695a400046 -r af33295c6d07 src/video/winrt/SDL_winrtvideo.cpp
>--- a/src/video/winrt/SDL_winrtvideo.cpp	Wed Dec 28 20:11:29 2016 +0100
>+++ b/src/video/winrt/SDL_winrtvideo.cpp	Thu Dec 29 11:49:18 2016 -0500
>@@ -621,7 +621,7 @@
>                 _this->egl_data->egl_config,
>                 cpp_winrtEglWindow, NULL);
>             if (data->egl_surface == NULL) {
>-                return SDL_SetError("eglCreateWindowSurface failed");
>+                return SDL_EGL_SetError("unable to create EGL native-window surface", "eglCreateWindowSurface");
>             }
>         } else if (data->coreWindow.Get() != nullptr) {
>             /* Attempt to create a window surface using newer versions of
>@@ -634,7 +634,7 @@
>                 coreWindowAsIInspectable,
>                 NULL);
>             if (data->egl_surface == NULL) {
>-                return SDL_SetError("eglCreateWindowSurface failed");
>+                return SDL_EGL_SetError("unable to create EGL native-window surface", "eglCreateWindowSurface");
>             }
>         } else {
>             return SDL_SetError("No supported means to create an EGL window surface are available");

Actions: View

Attachments on bug 3532: 2657

We are currently migrating Bugzilla to GitHub issues.Any changes made to the bug tracker now will be lost, so please do not post new bugs or make changes to them.When we're done, all bug URLs will redirect to their equivalent location on the new bug tracker.

We are currently migrating Bugzilla to GitHub issues.
Any changes made to the bug tracker now will be lost, so please do not post new bugs or make changes to them.
When we're done, all bug URLs will redirect to their equivalent location on the new bug tracker.