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 4e46a97e8f7fab77c38ac3f2c3f3620ea7ea3aeb (commit) from 87668c03813dbb86473d1080c58810a60e56f8f8 (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/4e46a97e8f7fab77c38ac3f2c3f3620ea7ea3... commit 4e46a97e8f7fab77c38ac3f2c3f3620ea7ea3aeb Author: BlueBear <jiri.bluebear.dluhos@gmail.com> Date: Sun Nov 6 17:22:10 2011 +0100 Fixed some typos in documentation. diff --git a/doc/filters.txt b/doc/filters.txt index af8e467..066d04c 100644 --- a/doc/filters.txt +++ b/doc/filters.txt @@ -3,7 +3,7 @@ Context filters Pixel filters for 'GP_Context'. -The context filter is basially an function that operates on context pixels. +The context filter is basically a function that operates on context pixels. The result may be stored into a new bitmap or placed to bitmap passed as argument or, in some cases, the filter could be used 'in place' so the result is stored into the same context as the one passed as filter source. @@ -11,7 +11,7 @@ is stored into the same context as the one passed as filter source. Common filter API ~~~~~~~~~~~~~~~~~ -The filters have, for your convinience unified API. +For convenience, the filters API is unified: * Each filter returns pointer to destination context or 'NULL' on failure * The first two arguments are source and destination @@ -19,13 +19,13 @@ The filters have, for your convinience unified API. Each filter function could be used in two modes. -By passing non 'NULL' argument as filter destination user requests result to +By passing non-'NULL' argument as filter destination user requests result to be stored into the destination context. The context must have correct pixel type and the context size must be big enough to store the result. -For filters that works 'in-place' (which is explicitly said for each filter) +For filters that work 'in-place' (which is explicitly said for each filter) the source and the destination could be the same context. Note that this is -not expected to work if you do several overlaping subcontextes and pass these +not expected to work if you do several overlaping subcontexts and pass these as arguments. When 'NULL' is passed as destination new context for storing the result is @@ -148,7 +148,7 @@ Rotate context by 90 degrees. Doesn't work 'in-place' (yet). -The destinatoin has to have the same pixel type and destination size must be +The destination has to have the same pixel type and destination size must be big enough to fit rotated context (eg. W and H are swapped). [source,c] @@ -252,8 +252,8 @@ destination defined by 'w' and 'h'. Nearest Neighbour Interpolation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Fast, but produces "pixelated" images may however work better for images with -sharp edges mostly consisting of big one colour regions (eg. doesn't blur the +Fast, but produces "pixelated" images. May however work better for images with +sharp edges mostly consisting of big one colour regions (it doesn't blur the result on upscaling). Bicubic Interpolation @@ -261,7 +261,7 @@ Bicubic Interpolation Works well as is on image upscaling. To get decent result on downscaling low-pass filter (gaussian blur) must be used on original image before actuall -downscaling. To do this reasonably fast we could cheat a little first resize -big images a little without the low-past filter, then apply low-pass filter and +downscaling. To do this reasonably fast we could cheat a little: first resize +big images a little without the low-pass filter, then apply low-pass filter and finally downscale it to desired size. diff --git a/doc/loaders.txt b/doc/loaders.txt index 73a6b28..7a752e8 100644 --- a/doc/loaders.txt +++ b/doc/loaders.txt @@ -36,7 +36,7 @@ Opens file and checks for 'PNG' signature upon successful return (file could be opened, signature matches), the opened file is returned and the file possition points right after the end of the 'PNG' signature. -This function is semi-internal, you should rather use functions listed bellow. +This function is semi-internal, you should rather use functions listed below. [source,c] ------------------------------------------------------------------------------- @@ -71,7 +71,7 @@ GP_RetCode GP_SavePNG(const char *dst_path, GP_Context *src, ------------------------------------------------------------------------------- Writes a Context into a 'PNG' image. If aborted by a callback, the opened file -is closed and unliked before the call returns 'GP_EINTR'. +is closed and removed before the call returns 'GP_EINTR'. Currently only 'RGB888' format is supported, you should convert the GP_Context to 'RGB888' before calling this function otherwise 'GP_ENOIMPL' will be @@ -93,7 +93,7 @@ Opens file and checks for 'JPG' signature upon successful return (file could be opened, signature matches), the opened file is returned and the file possition points right after the end of the 'JPG' signature. -This function is semi-internal, you should rather use functions listed bellow. +This function is semi-internal, you should rather use functions listed below. 'TODO:' This is not finished yet, currently this just opens and returns the file and the 'GP_ReadJPG()' reads the signature instead. @@ -120,7 +120,7 @@ GP_RetCode GP_LoadJPG(const char *src_path, GP_Context **res, ------------------------------------------------------------------------------- Same as abowe but takes path to the file as a parameter and check for the -signature. Basically this combines both of the calls abowe. +signature. Basically this combines both of the calls above. [source,c] ------------------------------------------------------------------------------- @@ -131,7 +131,7 @@ GP_RetCode GP_SaveJPG(const char *dst_path, GP_Context *src, ------------------------------------------------------------------------------- Writes a Context into a 'JPG' image. If aborted by a callback, the opened file -is closed and unliked before the call returns 'GP_EINTR'. +is closed and removed before the call returns 'GP_EINTR'. The 'JPG' format could store either 'G8' or 'RGB888' pixeltypes and you must convert the context into one of them before this fucntions is called. ----------------------------------------------------------------------- Summary of changes: doc/filters.txt | 20 ++++++++++---------- doc/loaders.txt | 10 +++++----- 2 files changed, 15 insertions(+), 15 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.")