This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project gfxprim.git. The branch, master has been updated via 1d8487ab33ea42b4fbf94078f939a6425e664298 (commit) via 2834bc3c2b6e45b7f34f6212407ce7a691dc5486 (commit) from 34512b0be720afdd2179f65d590881cbd91a14a3 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://repo.or.cz/w/gfxprim.git/commit/1d8487ab33ea42b4fbf94078f939a6425e664... commit 1d8487ab33ea42b4fbf94078f939a6425e664298 Author: Cyril Hrubis <metan@ucw.cz> Date: Wed Jul 11 23:54:51 2012 +0200 doc: Add docs for debug message layer. diff --git a/doc/Makefile b/doc/Makefile index 6329524..443e475 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,6 +1,6 @@ SOURCES=general.txt context.txt loaders.txt filters.txt basic_types.txt drawing_api.txt backends.txt gamma.txt grabbers.txt - environment_variables.txt + environment_variables.txt debug.txt PAGES=$(subst .txt,.html,$(SOURCES)) diff --git a/doc/api.txt b/doc/api.txt index c955dc6..e57953f 100644 --- a/doc/api.txt +++ b/doc/api.txt @@ -5,6 +5,7 @@ Cyril Hrubis <metan@ucw.cz> include::general.txt[] include::basic_types.txt[] include::environment_variables.txt[] +include::debug.txt[] include::context.txt[] include::gamma.txt[] include::drawing_api.txt[] diff --git a/doc/api_links.txt b/doc/api_links.txt index fffdf40..2e41996 100644 --- a/doc/api_links.txt +++ b/doc/api_links.txt @@ -10,6 +10,10 @@ Also available in link:api.html[all in one page form]. Describes how colors and pixels are handled also describes progress callback in great detail. + +. link:debug.html[Debug Messages] + + + Interface to debug layer. + + . link:context.html[Context] + The Context is description of in-memory bitmap including some meta-data diff --git a/doc/debug.txt b/doc/debug.txt new file mode 100644 index 0000000..dd46820 --- /dev/null +++ b/doc/debug.txt @@ -0,0 +1,51 @@ +Debug Messages +-------------- + +The GFXprim library includes a debug messages infrastructure in order to ease +debugging. + +[source,c] +------------------------------------------------------------------------------- +#include <core/GP_Debug.h> +/* or */ +#include <GP.h> + +void GP_SetDebugLevel(unsigned int level); + +unsigned int GP_GetDebugLevel(void); +------------------------------------------------------------------------------- + +Sets or gets library debug level. The default level is 0 at which only BUG, +WARNING, TODO and messages with debug level 0 are shown. + +Increasing this number would cause the library to be more verbose in debugging +messages. + +Setting debug level to 1 would expose debug messages when object was created +or destroyed or when particular algorithm has been started. + +Setting debug level to value higher than 1 would expose even more verbose +messages the current maximum used by debug messages is 4. + + +[source,c] +------------------------------------------------------------------------------- +#include <core/GP_Debug.h> +/* or */ +#include <GP.h> + +GP_DEBUG(level, ...) + +GP_TODO(...) + +GP_WARN(...) + +GP_BUG(...) + +void GP_DebugPrint(int level, const char *file, const char *function, int line, + const char *fmt, ...); +------------------------------------------------------------------------------- + +Printf-like macros used to create debug messages. All of them calls the +'GP_DebugPrint()' function with correct paramters. + http://repo.or.cz/w/gfxprim.git/commit/2834bc3c2b6e45b7f34f6212407ce7a691dc5... commit 2834bc3c2b6e45b7f34f6212407ce7a691dc5486 Author: Cyril Hrubis <metan@ucw.cz> Date: Mon Jul 9 14:04:42 2012 +0200 doc: Add docs for environment variables. diff --git a/doc/Makefile b/doc/Makefile index 9bc6c52..6329524 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,5 +1,6 @@ SOURCES=general.txt context.txt loaders.txt filters.txt basic_types.txt - drawing_api.txt backends.txt gamma.txt grabbers.txt + drawing_api.txt backends.txt gamma.txt grabbers.txt + environment_variables.txt PAGES=$(subst .txt,.html,$(SOURCES)) diff --git a/doc/api.txt b/doc/api.txt index 37979b4..c955dc6 100644 --- a/doc/api.txt +++ b/doc/api.txt @@ -4,6 +4,7 @@ Cyril Hrubis <metan@ucw.cz> include::general.txt[] include::basic_types.txt[] +include::environment_variables.txt[] include::context.txt[] include::gamma.txt[] include::drawing_api.txt[] diff --git a/doc/api_links.txt b/doc/api_links.txt index b4ef4d2..fffdf40 100644 --- a/doc/api_links.txt +++ b/doc/api_links.txt @@ -15,9 +15,13 @@ Also available in link:api.html[all in one page form]. The Context is description of in-memory bitmap including some meta-data (size, pixel format, etc...). + +. link:environment_variables.html[Environment Variables] + + + Description of environment variables that affects GFXprim behavior. + + . link:gamma.html[Gamma correction] + - The gama correction description and hanlding in GFXprim. + The gama correction description and handling in GFXprim. + . link:drawing_api.html[Drawing primitives] + diff --git a/doc/environment_variables.txt b/doc/environment_variables.txt new file mode 100644 index 0000000..c120528 --- /dev/null +++ b/doc/environment_variables.txt @@ -0,0 +1,23 @@ +Environment Variables +--------------------- + +The GFXprim library behavior may be changed by a couple of environment +variables: + +GP_THREADS +~~~~~~~~~~ + +'GP_THREADS' overrides GP_NrThreadsSet() settings. The value is the same as it +would have been set by GP_NrThreadsSet() which is described in the table +bellow: + +.GP_THREADS possible values +[width="60%",options="header"] +|============================================================================= +| Value | Description +| 0 | Use auto-detection, algorithms runs in nCPU threads unless the image + buffer is too small. +| 1 | Use one thread only. +| >=2 | Use N threads unless the image buffer is too small. +|============================================================================= + ----------------------------------------------------------------------- Summary of changes: doc/Makefile | 3 +- doc/api.txt | 2 + doc/api_links.txt | 10 +++++++- doc/debug.txt | 51 +++++++++++++++++++++++++++++++++++++++++ doc/environment_variables.txt | 23 ++++++++++++++++++ 5 files changed, 87 insertions(+), 2 deletions(-) create mode 100644 doc/debug.txt create mode 100644 doc/environment_variables.txt repo.or.cz automatic notification. Contact project admin jiri.bluebear.dluhos@gmail.com if you want to unsubscribe, or site admin admin@repo.or.cz if you receive no reply. -- gfxprim.git ("A simple 2D graphics library with emphasis on correctness and well-defined operation.")