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 09faee6cdc1fd7401ed8343a7539d4f547a5b7ec (commit) from 53c95916722f2cf7bf6bf0c768cf4e9ec79d6fb3 (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/09faee6cdc1fd7401ed8343a7539d4f547a5b... commit 09faee6cdc1fd7401ed8343a7539d4f547a5b7ec Author: Jiri BlueBear Dluhos <jiri.bluebear.dluhos@gmail.com> Date: Sun May 6 17:55:57 2012 +0200 Fixed (hopefully) a few small wording issues. diff --git a/doc/basic_types.txt b/doc/basic_types.txt index 32a8294..cab5435 100644 --- a/doc/basic_types.txt +++ b/doc/basic_types.txt @@ -21,12 +21,10 @@ supported pixel value. Color ~~~~~ -The 'GP_Color', in gfxprim is enumeration of symbolic color names. +The 'GP_Color' enumeration holds symbolic constants for basic colors. -Color could be converted for a given 'GP_PixelType' which will result into -'GP_Pixel' value suitable for usage with drawing functions. The color could be -also converted to color name (C string in English language) and C string may -be matched against table of color names. +A 'GP_Color' can be converted into a 'GP_Pixel' for a given 'GP_PixelType'. +Symbolic values can also be converted to/from strings (color name in English). The 'GP_Color' enum is defined as follows: @@ -49,9 +47,6 @@ typedef enum GP_Color { } GP_Color; -------------------------------------------------------------------------------- -Color and Pixel conversion functions, the last one returns 'true' in case of -successful match and conversion and false otherwise. - [source,c] -------------------------------------------------------------------------------- #include <core/GP_Color.h> @@ -70,7 +65,7 @@ bool GP_ColorNameToContextPixel(const char *color_name, GP_Context *context, GP_Pixel *pixel); -------------------------------------------------------------------------------- -Functions to convert color to pixel and color to context pixel. The last two +Functions for conversion between colors, pixels and color names. The last two returns true if color with such name was found. [source,c] diff --git a/doc/context.txt b/doc/context.txt index d7b6b21..1edcc1f 100644 --- a/doc/context.txt +++ b/doc/context.txt @@ -1,7 +1,8 @@ Drawing Context --------------- -The 'GP_Context' is data structure for storing 'in memory' bitmaps. +The 'GP_Context' structure describes a bitmap in memory. It contains all +metadata needed for drawing into a bitmap. Data Structure ~~~~~~~~~~~~~~ @@ -31,8 +32,8 @@ typedef struct GP_Context { } GP_Context; ------------------------------------------------------------------------------- -The 'GP_Context' holds meta-data needed for bitmap drawing. The bitmap is -stored in one dimensional array in byte-aligned lines. +The 'pixels' field points to the image data, stored as a one-dimensional +array of byte-aligned lines. Rotation ^^^^^^^^ @@ -92,8 +93,8 @@ GP_Size GP_ContextW(const GP_Context *context); GP_Size GP_ContextH(const GP_Context *context); ------------------------------------------------------------------------------- -Context base functions -~~~~~~~~~~~~~~~~~~~~~~ +Basic context functions +~~~~~~~~~~~~~~~~~~~~~~~ [source,c] ------------------------------------------------------------------------------- @@ -106,10 +107,12 @@ void GP_ContextInit(GP_Context *context, GP_Size w, GP_Size h, ------------------------------------------------------------------------------- Initalize given context accordingly to parameters, the rest of context -parameters are set to the default values. Eg. rotation flags are all set to -zero as well as the free_pixels flag. The bpp and bytes_per_row are computed -from the given pixel type and size. The pixels pointer may be 'NULL' and could -be changed later manually. +parameters are set to the default values (i.e. rotation flags are all set to +zero, 'free_pixels' flag is not set). Number of bits per pixel and +bytes per row are computed from the given pixel type and size. + +The 'pixels' pointer can be 'NULL' and can be changed later manually (the call +will *not* try to allocate the pixel memory automatically). [source,c] ------------------------------------------------------------------------------- @@ -122,9 +125,9 @@ GP_Context *GP_ContextAlloc(GP_Size w, GP_Size h, GP_PixelType type); The 'GP_ContextAlloc()' allocates and initalizes a context. -The orientation flags are all set to zero, the free_pixels flag is set and the +The orientation flags are all set to zero, the 'free_pixels' flag is set and the rest of the metadata are calculated accordingly to width, height and -pixel_type.The contxt->pixels pointer points to newly allocated bitmap with +pixel_type.The 'pixels' pointer will point to a newly allocated bitmap with appropriate size; the initial contents of the bitmap are undefined. [source,c] @@ -137,8 +140,9 @@ GP_Context *GP_ContextCopy(const GP_Context *src, int flag); ------------------------------------------------------------------------------- The 'GP_ContextCopy()' allocates and initalizes a copy of the context passed -as argument. If 'flag' is not zero, the bitmap (context->pixels) is copied -otherwise it's left uninitalized. +as argument. If 'flag' is set, the bitmap contents ('src->pixels') +are also copied; otherwise the copy will have the same dimensions but +undefined contents. [source,c] ------------------------------------------------------------------------------- ----------------------------------------------------------------------- Summary of changes: doc/basic_types.txt | 13 ++++--------- doc/context.txt | 30 +++++++++++++++++------------- 2 files changed, 21 insertions(+), 22 deletions(-) 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.")