2009-04-27 14:48:12 +00:00
|
|
|
/*
|
|
|
|
* Cogl
|
|
|
|
*
|
|
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
|
|
*
|
|
|
|
* Copyright (C) 2009 Intel Corporation.
|
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
2010-03-01 12:56:10 +00:00
|
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
*
|
2009-04-27 14:48:12 +00:00
|
|
|
*/
|
|
|
|
|
2009-02-23 12:47:02 +00:00
|
|
|
#ifdef HAVE_CONFIG_H
|
|
|
|
#include "config.h"
|
|
|
|
#endif
|
|
|
|
|
2010-02-17 14:38:11 +00:00
|
|
|
#include <stdlib.h>
|
2009-02-23 12:47:02 +00:00
|
|
|
#include <glib/gi18n-lib.h>
|
|
|
|
|
|
|
|
#include "cogl-debug.h"
|
|
|
|
|
|
|
|
#ifdef COGL_ENABLE_DEBUG
|
2010-02-17 14:38:11 +00:00
|
|
|
|
|
|
|
/* XXX: If you add a debug option, please also scroll down to
|
|
|
|
* cogl_arg_debug_cb() and add a "help" description of the option too.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* NB: Only these options get enabled if COGL_DEBUG=all is
|
|
|
|
* used since they don't affect the behaviour of Cogl they
|
|
|
|
* simply print out verbose information */
|
|
|
|
static const GDebugKey cogl_log_debug_keys[] = {
|
|
|
|
{ "handle", COGL_DEBUG_HANDLE },
|
|
|
|
{ "slicing", COGL_DEBUG_SLICING },
|
|
|
|
{ "atlas", COGL_DEBUG_ATLAS },
|
|
|
|
{ "blend-strings", COGL_DEBUG_BLEND_STRINGS },
|
|
|
|
{ "journal", COGL_DEBUG_JOURNAL },
|
|
|
|
{ "batching", COGL_DEBUG_BATCHING },
|
|
|
|
{ "matrices", COGL_DEBUG_MATRICES },
|
2009-02-28 16:03:11 +00:00
|
|
|
{ "draw", COGL_DEBUG_DRAW },
|
2010-02-17 18:45:08 +00:00
|
|
|
{ "opengl", COGL_DEBUG_OPENGL },
|
2009-04-17 14:10:55 +00:00
|
|
|
{ "pango", COGL_DEBUG_PANGO },
|
2010-05-26 16:14:53 +00:00
|
|
|
{ "show-source", COGL_DEBUG_SHOW_SOURCE},
|
|
|
|
{ "offscreen", COGL_DEBUG_OFFSCREEN }
|
2010-02-17 14:38:11 +00:00
|
|
|
};
|
|
|
|
static const int n_cogl_log_debug_keys =
|
|
|
|
G_N_ELEMENTS (cogl_log_debug_keys);
|
|
|
|
|
|
|
|
static const GDebugKey cogl_behavioural_debug_keys[] = {
|
2009-05-19 15:00:18 +00:00
|
|
|
{ "rectangles", COGL_DEBUG_RECTANGLES },
|
2009-06-05 12:50:00 +00:00
|
|
|
{ "disable-batching", COGL_DEBUG_DISABLE_BATCHING },
|
2009-06-17 00:59:28 +00:00
|
|
|
{ "disable-vbos", COGL_DEBUG_DISABLE_VBOS },
|
2009-10-26 11:01:33 +00:00
|
|
|
{ "disable-software-transform", COGL_DEBUG_DISABLE_SOFTWARE_TRANSFORM },
|
2009-12-04 18:55:53 +00:00
|
|
|
{ "force-scanline-paths", COGL_DEBUG_FORCE_SCANLINE_PATHS },
|
2010-01-21 15:34:19 +00:00
|
|
|
{ "dump-atlas-image", COGL_DEBUG_DUMP_ATLAS_IMAGE },
|
2010-04-26 09:01:43 +00:00
|
|
|
{ "disable-atlas", COGL_DEBUG_DISABLE_ATLAS },
|
|
|
|
{ "disable-texturing", COGL_DEBUG_DISABLE_TEXTURING},
|
|
|
|
{ "disable-arbfp", COGL_DEBUG_DISABLE_ARBFP},
|
2010-04-08 11:21:04 +00:00
|
|
|
{ "disable-glsl", COGL_DEBUG_DISABLE_GLSL},
|
|
|
|
{ "disable-blending", COGL_DEBUG_DISABLE_BLENDING}
|
2009-02-23 12:47:02 +00:00
|
|
|
};
|
2010-02-17 14:38:11 +00:00
|
|
|
static const int n_cogl_behavioural_debug_keys =
|
|
|
|
G_N_ELEMENTS (cogl_behavioural_debug_keys);
|
2009-02-23 12:47:02 +00:00
|
|
|
|
|
|
|
#endif /* COGL_ENABLE_DEBUG */
|
|
|
|
|
cogl: improves header and coding style consistency
We've had complaints that our Cogl code/headers are a bit "special" so
this is a first pass at tidying things up by giving them some
consistency. These changes are all consistent with how new code in Cogl
is being written, but the style isn't consistently applied across all
code yet.
There are two parts to this patch; but since each one required a large
amount of effort to maintain tidy indenting it made sense to combine the
changes to reduce the time spent re indenting the same lines.
The first change is to use a consistent style for declaring function
prototypes in headers. Cogl headers now consistently use this style for
prototypes:
return_type
cogl_function_name (CoglType arg0,
CoglType arg1);
Not everyone likes this style, but it seems that most of the currently
active Cogl developers agree on it.
The second change is to constrain the use of redundant glib data types
in Cogl. Uses of gint, guint, gfloat, glong, gulong and gchar have all
been replaced with int, unsigned int, float, long, unsigned long and char
respectively. When talking about pixel data; use of guchar has been
replaced with guint8, otherwise unsigned char can be used.
The glib types that we continue to use for portability are gboolean,
gint{8,16,32,64}, guint{8,16,32,64} and gsize.
The general intention is that Cogl should look palatable to the widest
range of C programmers including those outside the Gnome community so
- especially for the public API - we want to minimize the number of
foreign looking typedefs.
2010-02-10 01:57:32 +00:00
|
|
|
unsigned int cogl_debug_flags = 0;
|
2009-02-23 12:47:02 +00:00
|
|
|
|
|
|
|
#ifdef COGL_ENABLE_DEBUG
|
2010-02-17 14:38:11 +00:00
|
|
|
static unsigned int
|
|
|
|
_cogl_parse_debug_string (const char *value,
|
|
|
|
gboolean ignore_help)
|
|
|
|
{
|
|
|
|
unsigned int flags = 0;
|
|
|
|
|
|
|
|
if (ignore_help && strcmp (value, "help") == 0)
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
/* We don't want to let g_parse_debug_string handle "all" because
|
|
|
|
* literally enabling all the debug options wouldn't be useful to
|
|
|
|
* anyone; instead the all option enables all non behavioural
|
|
|
|
* options.
|
|
|
|
*/
|
|
|
|
if (strcmp (value, "all") == 0 ||
|
|
|
|
strcmp (value, "verbose") == 0)
|
|
|
|
{
|
|
|
|
int i;
|
|
|
|
for (i = 0; i < n_cogl_log_debug_keys; i++)
|
|
|
|
flags |= cogl_log_debug_keys[i].value;
|
|
|
|
}
|
|
|
|
else if (strcmp (value, "help") == 0)
|
|
|
|
{
|
|
|
|
g_printerr ("\n\n%28s\n", "Supported debug values:");
|
|
|
|
#define OPT(NAME, HELP) \
|
|
|
|
g_printerr ("%28s %s\n", NAME, HELP);
|
|
|
|
OPT ("handle:", "debug ref counting issues for Cogl objects");
|
|
|
|
OPT ("slicing:", "debug the creation of texture slices");
|
|
|
|
OPT ("atlas:", "debug texture atlas management");
|
|
|
|
OPT ("blend-strings:", "debug blend-string parsing");
|
|
|
|
OPT ("journal:", "view all geometry passing through the journal");
|
|
|
|
OPT ("batching:", "show how geometry is being batched in the journal");
|
|
|
|
OPT ("matrices:", "trace all matrix manipulation");
|
|
|
|
/* XXX: we should replace the "draw" option its very hand wavy... */
|
|
|
|
OPT ("draw:", "misc tracing of some drawing operations");
|
|
|
|
OPT ("pango:", "trace the pango renderer");
|
|
|
|
OPT ("rectangles:", "add wire outlines for all rectangular geometry");
|
|
|
|
OPT ("disable-batching:", "disable the journal batching");
|
|
|
|
OPT ("disable-vbos:", "disable use of OpenGL vertex buffer objects");
|
|
|
|
OPT ("disable-software-transform",
|
|
|
|
"use the GPU to transform rectangular geometry");
|
|
|
|
OPT ("force-scanline-paths:", "use a scanline based path rasterizer");
|
|
|
|
OPT ("dump-atlas-image:", "dump atlas changes to an image file");
|
|
|
|
OPT ("disable-atlas:", "disable texture atlasing");
|
2010-04-26 09:01:43 +00:00
|
|
|
OPT ("disable-texturing:", "disable texturing primitives");
|
|
|
|
OPT ("disable-arbfp:", "disable use of ARBfp");
|
|
|
|
OPT ("disable-glsl:", "disable use of GLSL");
|
2010-04-08 11:21:04 +00:00
|
|
|
OPT ("disable-blending:", "disable use of blending");
|
2010-04-26 09:01:43 +00:00
|
|
|
OPT ("show-source:", "show generated ARBfp/GLSL");
|
2010-02-17 18:45:08 +00:00
|
|
|
OPT ("opengl:", "traces some select OpenGL calls");
|
2010-05-26 16:14:53 +00:00
|
|
|
OPT ("offscreen:", "debug offscreen support");
|
2010-02-17 14:38:11 +00:00
|
|
|
g_printerr ("\n%28s\n", "Special debug values:");
|
|
|
|
OPT ("all:", "Enables all non-behavioural debug options");
|
|
|
|
OPT ("verbose:", "Enables all non-behavioural debug options");
|
|
|
|
#undef OPT
|
|
|
|
exit (1);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
flags |=
|
|
|
|
g_parse_debug_string (value,
|
|
|
|
cogl_log_debug_keys,
|
|
|
|
n_cogl_log_debug_keys);
|
|
|
|
flags |=
|
|
|
|
g_parse_debug_string (value,
|
|
|
|
cogl_behavioural_debug_keys,
|
|
|
|
n_cogl_behavioural_debug_keys);
|
|
|
|
}
|
|
|
|
|
|
|
|
return flags;
|
|
|
|
}
|
|
|
|
|
2009-02-23 12:47:02 +00:00
|
|
|
static gboolean
|
|
|
|
cogl_arg_debug_cb (const char *key,
|
|
|
|
const char *value,
|
|
|
|
gpointer user_data)
|
|
|
|
{
|
2010-02-17 14:38:11 +00:00
|
|
|
cogl_debug_flags |= _cogl_parse_debug_string (value, FALSE);
|
2009-02-23 12:47:02 +00:00
|
|
|
return TRUE;
|
|
|
|
}
|
|
|
|
|
|
|
|
static gboolean
|
|
|
|
cogl_arg_no_debug_cb (const char *key,
|
cogl: improves header and coding style consistency
We've had complaints that our Cogl code/headers are a bit "special" so
this is a first pass at tidying things up by giving them some
consistency. These changes are all consistent with how new code in Cogl
is being written, but the style isn't consistently applied across all
code yet.
There are two parts to this patch; but since each one required a large
amount of effort to maintain tidy indenting it made sense to combine the
changes to reduce the time spent re indenting the same lines.
The first change is to use a consistent style for declaring function
prototypes in headers. Cogl headers now consistently use this style for
prototypes:
return_type
cogl_function_name (CoglType arg0,
CoglType arg1);
Not everyone likes this style, but it seems that most of the currently
active Cogl developers agree on it.
The second change is to constrain the use of redundant glib data types
in Cogl. Uses of gint, guint, gfloat, glong, gulong and gchar have all
been replaced with int, unsigned int, float, long, unsigned long and char
respectively. When talking about pixel data; use of guchar has been
replaced with guint8, otherwise unsigned char can be used.
The glib types that we continue to use for portability are gboolean,
gint{8,16,32,64}, guint{8,16,32,64} and gsize.
The general intention is that Cogl should look palatable to the widest
range of C programmers including those outside the Gnome community so
- especially for the public API - we want to minimize the number of
foreign looking typedefs.
2010-02-10 01:57:32 +00:00
|
|
|
const char *value,
|
|
|
|
gpointer user_data)
|
2009-02-23 12:47:02 +00:00
|
|
|
{
|
2010-02-17 14:38:11 +00:00
|
|
|
cogl_debug_flags &= ~_cogl_parse_debug_string (value, TRUE);
|
2009-02-23 12:47:02 +00:00
|
|
|
return TRUE;
|
|
|
|
}
|
2010-02-17 14:38:11 +00:00
|
|
|
#endif /* COGL_ENABLE_DEBUG */
|
2009-02-23 12:47:02 +00:00
|
|
|
|
|
|
|
static GOptionEntry cogl_args[] = {
|
2010-03-02 02:07:40 +00:00
|
|
|
#ifdef COGL_ENABLE_DEBUG
|
2009-02-23 12:47:02 +00:00
|
|
|
{ "cogl-debug", 0, 0, G_OPTION_ARG_CALLBACK, cogl_arg_debug_cb,
|
|
|
|
N_("COGL debugging flags to set"), "FLAGS" },
|
|
|
|
{ "cogl-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, cogl_arg_no_debug_cb,
|
|
|
|
N_("COGL debugging flags to unset"), "FLAGS" },
|
2010-03-02 02:07:40 +00:00
|
|
|
#endif /* COGL_ENABLE_DEBUG */
|
2009-02-23 12:47:02 +00:00
|
|
|
{ NULL, },
|
|
|
|
};
|
|
|
|
|
|
|
|
static gboolean
|
|
|
|
pre_parse_hook (GOptionContext *context,
|
|
|
|
GOptionGroup *group,
|
|
|
|
gpointer data,
|
|
|
|
GError **error)
|
|
|
|
{
|
2009-07-28 12:57:07 +00:00
|
|
|
#ifdef COGL_ENABLE_DEBUG
|
2009-02-23 12:47:02 +00:00
|
|
|
const char *env_string;
|
|
|
|
|
|
|
|
env_string = g_getenv ("COGL_DEBUG");
|
|
|
|
if (env_string != NULL)
|
|
|
|
{
|
2010-02-17 14:38:11 +00:00
|
|
|
cogl_debug_flags |= _cogl_parse_debug_string (env_string, FALSE);
|
2009-02-23 12:47:02 +00:00
|
|
|
env_string = NULL;
|
|
|
|
}
|
|
|
|
#endif /* COGL_ENABLE_DEBUG */
|
|
|
|
|
|
|
|
return TRUE;
|
|
|
|
}
|
|
|
|
|
|
|
|
GOptionGroup *
|
|
|
|
cogl_get_option_group (void)
|
|
|
|
{
|
|
|
|
GOptionGroup *group;
|
|
|
|
|
|
|
|
group = g_option_group_new ("cogl",
|
|
|
|
_("COGL Options"),
|
|
|
|
_("Show COGL options"),
|
|
|
|
NULL, NULL);
|
|
|
|
|
|
|
|
g_option_group_set_parse_hooks (group, pre_parse_hook, NULL);
|
|
|
|
g_option_group_add_entries (group, cogl_args);
|
|
|
|
g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
|
|
|
|
|
|
|
|
return group;
|
|
|
|
}
|