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 9800d72f27df325aa25aaa5b35851551ef010921 (commit) from ee7841b92486c22488a2efcb8fe29ea8642f863c (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/9800d72f27df325aa25aaa5b35851551ef010... commit 9800d72f27df325aa25aaa5b35851551ef010921 Author: BlueBear <jiri.bluebear.dluhos@gmail.com> Date: Sun Nov 27 21:30:48 2011 +0100 Slightly refined documentation for circles and ellipses. diff --git a/doc/drawing_api.txt b/doc/drawing_api.txt index 75a67e4..e73a07c 100644 --- a/doc/drawing_api.txt +++ b/doc/drawing_api.txt @@ -79,7 +79,10 @@ void GP_Circle(GP_Context *context, GP_Coord xcenter, GP_Coord ycenter, GP_Size r, GP_Pixel pixel); -------------------------------------------------------------------------------- -Draws a circle. +Draws a circle centered at (xcenter, ycenter) with radius 'r' (in pixels). + +The circle is drawn so that all affected pixels will fit into a square +specified by points (xcenter-r, ycenter-r, xcenter+r, ycenter+r), inclusive. [source,c] -------------------------------------------------------------------------------- @@ -89,6 +92,10 @@ void GP_FillCircle(GP_Context *context, GP_Coord xcenter, GP_Coord ycenter, Draws a filled circle. +The set of pixels affected by 'GP_FillCircle()' is exactly the same as if +drawing the circle boundary using GP_Circle() and then filling all pixels +within the boundary with the same color. + Rings ~~~~~ [source,c] @@ -97,7 +104,10 @@ void GP_Ring(GP_Context *context, GP_Coord xcenter, GP_Coord ycenter, GP_Size r1, GP_Size r2, GP_Pixel pixel); -------------------------------------------------------------------------------- -Draws a ring. +Draws a ring (two circles centered at (xcenter, ycenter) with radii 'r1' and 'r2'). + +The result is exactly the same as calling 'GP_Circle()' with the same center +and appropriate radii. [source,c] -------------------------------------------------------------------------------- @@ -119,7 +129,10 @@ void GP_Ellipse(GP_Context *context, GP_Coord xcenter, GP_Coord ycenter, GP_Size a, GP_Size b, GP_Pixel pixel); -------------------------------------------------------------------------------- -Draws an ellipse. +Draws an axis-aligned ellipse. + +The ellipse is drawn so that all affected pixels will fit into a rectangle +specified by points (xcenter-a, ycenter-b, xcenter+a, ycenter+b), inclusive. [source,c] -------------------------------------------------------------------------------- @@ -127,7 +140,7 @@ void GP_FillEllipse(GP_Context *context, GP_Coord xcenter, GP_Coord ycenter, GP_Size a, GP_Size b, GP_Pixel pixel); -------------------------------------------------------------------------------- -Draws a filled ellipse. +Draws a filled axis-aligned ellipse. Triangles ~~~~~~~~~ ----------------------------------------------------------------------- Summary of changes: doc/drawing_api.txt | 21 +++++++++++++++++---- 1 files changed, 17 insertions(+), 4 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.")