From 761e24b17d333141ae508662f2e952c765a9ee55 Mon Sep 17 00:00:00 2001 From: ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com> Date: Thu, 13 Oct 2022 10:16:06 +0200 Subject: Document fl_circle() with and w/o complex drawing API (#511) --- FL/fl_draw.H | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/FL/fl_draw.H b/FL/fl_draw.H index b801c715d..f30c33811 100644 --- a/FL/fl_draw.H +++ b/FL/fl_draw.H @@ -618,10 +618,15 @@ inline void fl_arc(double x, double y, double r, double start, double end) { } /** fl_circle(x,y,r) is equivalent to fl_arc(x,y,r,0,360), but may be faster. - - It must be the \e only thing in the path: if you want a circle as part of - a complex polygon you must use fl_arc(). - \param[in] x,y,r center and radius of circle + \param[in] x,y,r center and radius of circle + + \note fl_circle() is best used as part of the \ref drawing_complex API, that is, + flanked by fl_begin_XXX() and fl_end_XXX() calls where XXX can be 'loop' or 'polygon' + to draw, respectively a circle or a disk. Transformation functions (e.g., fl_scale(double, double)) + can be also used for fl_circle() to draw empty of filled ellipses. + It must be the \e only thing in the path: if you want a circle as part of + a complex polygon you must use fl_arc(). +
Nevertheless, fl_circle() can also be used by itself to draw circles. */ inline void fl_circle(double x, double y, double r) { fl_graphics_driver->circle(x, y, r); -- cgit v1.2.3