Skip to content
This repository has been archived by the owner on Feb 11, 2021. It is now read-only.

Commit

Permalink
Fixed bug 1837 - Use error extension instead of glGetError()
Browse files Browse the repository at this point in the history 
Implemented support for GL_ARB_debug_output, but was unable to test it on Mac OS X.
  • Loading branch information
@slouken
slouken committed May 20, 2013
1 parent ee2cb75 commit 750a19c
Show file tree
Hide file tree
Showing 5 changed files with 131 additions and 42 deletions.
1 change: 1 addition & 0 deletions include/SDL_test_common.h
View file
Expand Up @@ -104,6 +104,7 @@ typedef struct
int gl_accelerated;
int gl_major_version;
int gl_minor_version;
int gl_debug;
} SDLTest_CommonState;

#include "begin_code.h"
Expand Down
2 changes: 1 addition & 1 deletion src/render/opengl/SDL_glfuncs.h
View file
Expand Up @@ -152,7 +152,7 @@ SDL_PROC_UNUSED(void, glGetMaterialiv,
SDL_PROC_UNUSED(void, glGetPixelMapfv, (GLenum map, GLfloat * values))
SDL_PROC_UNUSED(void, glGetPixelMapuiv, (GLenum map, GLuint * values))
SDL_PROC_UNUSED(void, glGetPixelMapusv, (GLenum map, GLushort * values))
SDL_PROC_UNUSED(void, glGetPointerv, (GLenum pname, GLvoid * *params))
SDL_PROC(void, glGetPointerv, (GLenum pname, GLvoid * *params))
SDL_PROC_UNUSED(void, glGetPolygonStipple, (GLubyte * mask))
SDL_PROC(const GLubyte *, glGetString, (GLenum name))
SDL_PROC_UNUSED(void, glGetTexEnvfv,
Expand Down
159 changes: 119 additions & 40 deletions src/render/opengl/SDL_render_gl.c
View file
Expand Up @@ -100,6 +100,13 @@ struct GL_FBOList
typedef struct
{
SDL_GLContext context;

SDL_bool GL_ARB_debug_output_supported;
int errors;
char **error_messages;
GLDEBUGPROCARB next_error_callback;
GLvoid *next_error_userparam;

SDL_bool GL_ARB_texture_rectangle_supported;
struct {
GL_Shader shader;
Expand Down Expand Up @@ -151,7 +158,7 @@ typedef struct
GL_FBOList *fbo;
} GL_TextureData;

static __inline__ const char*
SDL_FORCE_INLINE const char*
GL_TranslateError (GLenum error)
{
#define GL_ERROR_TRANSLATE(e) case e: return #e;
Expand All @@ -170,22 +177,57 @@ GL_TranslateError (GLenum error)
#undef GL_ERROR_TRANSLATE
}

static __inline__ int
GL_CheckAllErrors (const char *prefix, SDL_Renderer * renderer, const char *file, int line, const char *function)
SDL_FORCE_INLINE void
GL_ClearErrors(SDL_Renderer *renderer)
{
GL_RenderData *data = (GL_RenderData *) renderer->driverdata;

if (data->GL_ARB_debug_output_supported) {
if (data->errors) {
int i;
for (i = 0; i < data->errors; ++i) {
SDL_free(data->error_messages[i]);
}
SDL_free(data->error_messages);

data->errors = 0;
data->error_messages = NULL;
}
} else {
while (data->glGetError() != GL_NO_ERROR) {
continue;
}
}
}

SDL_FORCE_INLINE int
GL_CheckAllErrors (const char *prefix, SDL_Renderer *renderer, const char *file, int line, const char *function)
{
GL_RenderData *data = (GL_RenderData *) renderer->driverdata;
int ret = 0;
/* check gl errors (can return multiple errors) */
for (;;) {
GLenum error = data->glGetError();
if (error != GL_NO_ERROR) {
if (prefix == NULL || prefix[0] == '\0') {
prefix = "generic";

if (data->GL_ARB_debug_output_supported) {
if (data->errors) {
int i;
for (i = 0; i < data->errors; ++i) {
SDL_SetError("%s: %s (%d): %s %s", prefix, file, line, function, data->error_messages[i]);
ret = -1;
}
GL_ClearErrors(renderer);
}
} else {
/* check gl errors (can return multiple errors) */
for (;;) {
GLenum error = data->glGetError();
if (error != GL_NO_ERROR) {
if (prefix == NULL || prefix[0] == '\0') {
prefix = "generic";
}
SDL_SetError("%s: %s (%d): %s %s (0x%X)", prefix, file, line, function, GL_TranslateError(error), error);
ret = -1;
} else {
break;
}
SDL_SetError("%s: %s (%d): %s %s (0x%X)", prefix, file, line, function, GL_TranslateError(error), error);
ret++;
} else {
break;
}
}
return ret;
Expand Down Expand Up @@ -226,6 +268,7 @@ GL_ActivateRenderer(SDL_Renderer * renderer)
{
GL_RenderData *data = (GL_RenderData *) renderer->driverdata;

GL_ClearErrors(renderer);
if (SDL_CurrentContext != data->context) {
if (SDL_GL_MakeCurrent(renderer->window, data->context) < 0) {
return -1;
Expand Down Expand Up @@ -264,8 +307,35 @@ GL_ResetState(SDL_Renderer *renderer)
GL_CheckError("", renderer);
}

static void
GL_HandleDebugMessage(GLenum source, GLenum type, GLuint id, GLenum severity, GLsizei length, const char *message, void *userParam)
{
SDL_Renderer *renderer = (SDL_Renderer *) userParam;
GL_RenderData *data = (GL_RenderData *) renderer->driverdata;

if (type == GL_DEBUG_TYPE_ERROR_ARB) {
/* Record this error */
++data->errors;
data->error_messages = SDL_realloc(data->error_messages, data->errors * sizeof(*data->error_messages));
if (data->error_messages) {
data->error_messages[data->errors-1] = SDL_strdup(message);
}
}
printf("%s\n", message);

/* If there's another error callback, pass it along, otherwise log it */
if (data->next_error_callback) {
data->next_error_callback(source, type, id, severity, length, message, data->next_error_userparam);
} else {
if (type == GL_DEBUG_TYPE_ERROR_ARB) {
SDL_LogError(SDL_LOG_CATEGORY_RENDER, "%s", message);
} else {
SDL_LogDebug(SDL_LOG_CATEGORY_RENDER, "%s", message);
}
}
}

GL_FBOList *
static GL_FBOList *
GL_GetFBO(GL_RenderData *data, Uint32 w, Uint32 h)
{
GL_FBOList *result = data->framebuffers;
Expand Down Expand Up @@ -374,6 +444,16 @@ GL_CreateRenderer(SDL_Window * window, Uint32 flags)
renderer->info.flags |= SDL_RENDERER_PRESENTVSYNC;
}

/* Check for debug output support */
if (SDL_GL_ExtensionSupported("GL_ARB_debug_output")) {
PFNGLDEBUGMESSAGECALLBACKARBPROC glDebugMessageCallbackARBFunc = (PFNGLDEBUGMESSAGECALLBACKARBPROC) SDL_GL_GetProcAddress("glDebugMessageCallbackARB");

data->GL_ARB_debug_output_supported = SDL_TRUE;
data->glGetPointerv(GL_DEBUG_CALLBACK_FUNCTION_ARB, (GLvoid **)&data->next_error_callback);
data->glGetPointerv(GL_DEBUG_CALLBACK_USER_PARAM_ARB, &data->next_error_userparam);
glDebugMessageCallbackARBFunc(GL_HandleDebugMessage, renderer);
}

if (SDL_GL_ExtensionSupported("GL_ARB_texture_rectangle")
|| SDL_GL_ExtensionSupported("GL_EXT_texture_rectangle")) {
data->GL_ARB_texture_rectangle_supported = SDL_TRUE;
Expand Down Expand Up @@ -442,7 +522,7 @@ GL_WindowEvent(SDL_Renderer * renderer, const SDL_WindowEvent *event)
}
}

static __inline__ int
SDL_FORCE_INLINE int
power_of_2(int input)
{
int value = 1;
Expand All @@ -453,7 +533,7 @@ power_of_2(int input)
return value;
}

static __inline__ SDL_bool
SDL_FORCE_INLINE SDL_bool
convert_format(GL_RenderData *renderdata, Uint32 pixel_format,
GLint* internalFormat, GLenum* format, GLenum* type)
{
Expand Down Expand Up @@ -602,7 +682,7 @@ GL_CreateTexture(SDL_Renderer * renderer, SDL_Texture * texture)
texture_h, 0, format, type, NULL);
}
renderdata->glDisable(data->type);
if (GL_CheckError("glTexImage2D()", renderer) > 0) {
if (GL_CheckError("glTexImage2D()", renderer) < 0) {
return -1;
}

Expand Down Expand Up @@ -641,8 +721,7 @@ GL_CreateTexture(SDL_Renderer * renderer, SDL_Texture * texture)
renderdata->glDisable(data->type);
}

GL_CheckError("", renderer);
return 0;
return GL_CheckError("", renderer);
}

static int
Expand All @@ -654,7 +733,6 @@ GL_UpdateTexture(SDL_Renderer * renderer, SDL_Texture * texture,

GL_ActivateRenderer(renderer);

GL_CheckError("", renderer);
renderdata->glEnable(data->type);
renderdata->glBindTexture(data->type, data->texture);
renderdata->glPixelStorei(GL_UNPACK_ALIGNMENT, 1);
Expand Down Expand Up @@ -689,10 +767,7 @@ GL_UpdateTexture(SDL_Renderer * renderer, SDL_Texture * texture,
data->format, data->formattype, pixels);
}
renderdata->glDisable(data->type);
if (GL_CheckError("glTexSubImage2D()", renderer) > 0) {
return -1;
}
return 0;
return GL_CheckError("glTexSubImage2D()", renderer);
}

static int
Expand Down Expand Up @@ -782,8 +857,7 @@ GL_UpdateViewport(SDL_Renderer * renderer)
(GLdouble) 0,
0.0, 1.0);
}
GL_CheckError("", renderer);
return 0;
return GL_CheckError("", renderer);
}

static int
Expand Down Expand Up @@ -965,9 +1039,7 @@ GL_RenderDrawLines(SDL_Renderer * renderer, const SDL_FPoint * points,
#endif
data->glEnd();
}
GL_CheckError("", renderer);

return 0;
return GL_CheckError("", renderer);
}

static int
Expand All @@ -983,9 +1055,7 @@ GL_RenderFillRects(SDL_Renderer * renderer, const SDL_FRect * rects, int count)

data->glRectf(rect->x, rect->y, rect->x + rect->w, rect->y + rect->h);
}
GL_CheckError("", renderer);

return 0;
return GL_CheckError("", renderer);
}

static int
Expand Down Expand Up @@ -1052,9 +1122,7 @@ GL_RenderCopy(SDL_Renderer * renderer, SDL_Texture * texture,

data->glDisable(texturedata->type);

GL_CheckError("", renderer);

return 0;
return GL_CheckError("", renderer);
}

static int
Expand All @@ -1067,6 +1135,7 @@ GL_RenderCopyEx(SDL_Renderer * renderer, SDL_Texture * texture,
GLfloat minx, miny, maxx, maxy;
GLfloat centerx, centery;
GLfloat minu, maxu, minv, maxv;

GL_ActivateRenderer(renderer);

data->glEnable(texturedata->type);
Expand Down Expand Up @@ -1144,9 +1213,7 @@ GL_RenderCopyEx(SDL_Renderer * renderer, SDL_Texture * texture,

data->glDisable(texturedata->type);

GL_CheckError("", renderer);

return 0;
return GL_CheckError("", renderer);
}

static int
Expand Down Expand Up @@ -1247,6 +1314,14 @@ GL_DestroyRenderer(SDL_Renderer * renderer)
GL_RenderData *data = (GL_RenderData *) renderer->driverdata;

if (data) {
GL_ClearErrors(renderer);
if (data->GL_ARB_debug_output_supported) {
PFNGLDEBUGMESSAGECALLBACKARBPROC glDebugMessageCallbackARBFunc = (PFNGLDEBUGMESSAGECALLBACKARBPROC) SDL_GL_GetProcAddress("glDebugMessageCallbackARB");

/* Uh oh, we don't have a safe way of removing ourselves from the callback chain, if it changed after we set our callback. */
/* For now, just always replace the callback with the original one */
glDebugMessageCallbackARBFunc(data->next_error_callback, data->next_error_userparam);
}
if (data->shaders) {
GL_DestroyShaderContext(data->shaders);
}
Expand All @@ -1266,7 +1341,9 @@ GL_DestroyRenderer(SDL_Renderer * renderer)
SDL_free(renderer);
}

static int GL_BindTexture (SDL_Renderer * renderer, SDL_Texture *texture, float *texw, float *texh) {
static int
GL_BindTexture (SDL_Renderer * renderer, SDL_Texture *texture, float *texw, float *texh)
{
GL_RenderData *data = (GL_RenderData *) renderer->driverdata;
GL_TextureData *texturedata = (GL_TextureData *) texture->driverdata;
GL_ActivateRenderer(renderer);
Expand All @@ -1289,7 +1366,9 @@ static int GL_BindTexture (SDL_Renderer * renderer, SDL_Texture *texture, float
return 0;
}

static int GL_UnbindTexture (SDL_Renderer * renderer, SDL_Texture *texture) {
static int
GL_UnbindTexture (SDL_Renderer * renderer, SDL_Texture *texture)
{
GL_RenderData *data = (GL_RenderData *) renderer->driverdata;
GL_TextureData *texturedata = (GL_TextureData *) texture->driverdata;
GL_ActivateRenderer(renderer);
Expand Down
10 changes: 9 additions & 1 deletion src/test/SDL_test_common.c
View file
Expand Up @@ -27,7 +27,7 @@
#include <stdio.h>

#define VIDEO_USAGE \
"[--video driver] [--renderer driver] [--info all|video|modes|render|event] [--log all|error|system|audio|video|render|input] [--display N] [--fullscreen | --fullscreen-desktop | --windows N] [--title title] [--icon icon.bmp] [--center | --position X,Y] [--geometry WxH] [--min-geometry WxH] [--max-geometry WxH] [--depth N] [--refresh R] [--vsync] [--noframe] [--resize] [--minimize] [--maximize] [--grab]"
"[--video driver] [--renderer driver] [--gldebug] [--info all|video|modes|render|event] [--log all|error|system|audio|video|render|input] [--display N] [--fullscreen | --fullscreen-desktop | --windows N] [--title title] [--icon icon.bmp] [--center | --position X,Y] [--geometry WxH] [--min-geometry WxH] [--max-geometry WxH] [--depth N] [--refresh R] [--vsync] [--noframe] [--resize] [--minimize] [--maximize] [--grab]"

#define AUDIO_USAGE \
"[--rate N] [--format U8|S8|U16|U16LE|U16BE|S16|S16LE|S16BE] [--channels N] [--samples N]"
Expand Down Expand Up @@ -74,6 +74,7 @@ SDLTest_CommonCreateState(char **argv, Uint32 flags)
state->gl_multisamplesamples = 0;
state->gl_retained_backing = 1;
state->gl_accelerated = -1;
state->gl_debug = 0;

return state;
}
Expand All @@ -99,6 +100,10 @@ SDLTest_CommonArg(SDLTest_CommonState * state, int index)
state->renderdriver = argv[index];
return 2;
}
if (SDL_strcasecmp(argv[index], "--gldebug") == 0) {
state->gl_debug = 1;
return 1;
}
if (SDL_strcasecmp(argv[index], "--info") == 0) {
++index;
if (!argv[index]) {
Expand Down Expand Up @@ -656,6 +661,9 @@ SDLTest_CommonInit(SDLTest_CommonState * state)
SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, state->gl_major_version);
SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, state->gl_minor_version);
}
if (state->gl_debug) {
SDL_GL_SetAttribute(SDL_GL_CONTEXT_FLAGS, SDL_GL_CONTEXT_DEBUG_FLAG);
}

if (state->verbose & VERBOSE_MODES) {
SDL_Rect bounds;
Expand Down
1 change: 1 addition & 0 deletions test/testgl2.c
View file
Expand Up @@ -255,6 +255,7 @@ main(int argc, char *argv[])
printf("Vendor : %s\n", glGetString(GL_VENDOR));
printf("Renderer : %s\n", glGetString(GL_RENDERER));
printf("Version : %s\n", glGetString(GL_VERSION));
printf("Extensions : %s\n", glGetString(GL_EXTENSIONS));
printf("\n");

status = SDL_GL_GetAttribute(SDL_GL_RED_SIZE, &value);
Expand Down

0 comments on commit 750a19c

Please sign in to comment.