summaryrefslogtreecommitdiff
path: root/FL/fl_draw.H
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2024-07-20 12:55:27 -0700
committerGreg Ercolano <erco@seriss.com>2024-07-20 12:55:27 -0700
commit7f998bac6007a6433740bc82ce7412233250d44a (patch)
treea07e6d4d61a45d66f6d52fad11d2e7da57773ccf /FL/fl_draw.H
parente64e708345f2b657b183361fa506a63086fa8471 (diff)
fl_line_style() diagrams replace ascii art (#1016)
Diffstat (limited to 'FL/fl_draw.H')
-rw-r--r--FL/fl_draw.H17
1 files changed, 12 insertions, 5 deletions
diff --git a/FL/fl_draw.H b/FL/fl_draw.H
index b7f81a53a..cc23b28e9 100644
--- a/FL/fl_draw.H
+++ b/FL/fl_draw.H
@@ -223,6 +223,9 @@ inline void fl_point(int x, int y) {
If you change this it is your responsibility to set it back to the default
using \c fl_line_style(0).
+ \image html fl_line_style.png "fl_line_style() styles"
+ \image latex fl_line_style.png "fl_line_style() styles" width=4cm
+
\param[in] style A bitmask which is a bitwise-OR of \ref LineStyles "Line Styles",
a cap style, and a join style. If you don't specify a dash type you
will get a solid line. If you don't specify a cap or join type
@@ -251,12 +254,16 @@ inline void fl_line_style(int style, int width = 0, char *dashes = 0) {
}
/// \anchor LineStyles
+///
+/// \image html fl_line_style.png "fl_line_style() styles"
+/// \image latex fl_line_style.png "fl_line_style() styles" width=4cm
+///
enum {
- FL_SOLID = 0, ///< line style: <tt>___________</tt>
- FL_DASH = 1, ///< line style: <tt>_ _ _ _ _ _</tt>
- FL_DOT = 2, ///< line style: <tt>. . . . . .</tt>
- FL_DASHDOT = 3, ///< line style: <tt>_ . _ . _ .</tt>
- FL_DASHDOTDOT = 4, ///< line style: <tt>_ . . _ . .</tt>
+ FL_SOLID = 0, ///< line style: solid line
+ FL_DASH = 1, ///< line style: 75% dashed line
+ FL_DOT = 2, ///< line style: 50% pixel dotted
+ FL_DASHDOT = 3, ///< line style: dash / dot pattern
+ FL_DASHDOTDOT = 4, ///< line style: dash / two dot pattern
FL_CAP_FLAT = 0x100, ///< cap style: end is flat
FL_CAP_ROUND = 0x200, ///< cap style: end is round