summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorManolo Gouy <Manolo>2018-08-04 16:42:32 +0000
committerManolo Gouy <Manolo>2018-08-04 16:42:32 +0000
commita4194a40ab2dcb7aff84df6fa5a2871893a9c1fc (patch)
tree6c8c372995696085671fdb46664ceb204a35bb11 /FL
parent61e53a8cd48a089b6ae1ddff3aed3e0db504461a (diff)
Have the Doxygen doc of fl_draw_pixmap() show the default value of the last argument.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@13005 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL')
-rw-r--r--FL/fl_draw.H20
1 files changed, 18 insertions, 2 deletions
diff --git a/FL/fl_draw.H b/FL/fl_draw.H
index 11a7f3bc6..f1a867071 100644
--- a/FL/fl_draw.H
+++ b/FL/fl_draw.H
@@ -796,8 +796,24 @@ inline char fl_can_do_alpha_blending() {return Fl_Graphics_Driver::default_drive
FL_EXPORT uchar *fl_read_image(uchar *p,int X,int Y,int W,int H,int alpha=0);
// pixmaps:
-FL_EXPORT int fl_draw_pixmap(/*const*/ char* const* data, int x,int y,Fl_Color=FL_GRAY);
-FL_EXPORT int fl_draw_pixmap(const char* const* cdata, int x,int y,Fl_Color=FL_GRAY);
+/**
+ Draw XPM image data, with the top-left corner at the given position.
+ The image is dithered on 8-bit displays so you won't lose color
+ space for programs displaying both images and pixmaps.
+ \param[in] data pointer to XPM image data
+ \param[in] x,y position of top-left corner
+ \param[in] bg background color
+ \returns 0 if there was any error decoding the XPM data.
+ */
+FL_EXPORT int fl_draw_pixmap(const char* const* data, int x,int y,Fl_Color bg=FL_GRAY);
+/**
+ Draw XPM image data, with the top-left corner at the given position.
+ \see fl_draw_pixmap(const char* const* data, int x, int y, Fl_Color bg)
+ */
+inline int fl_draw_pixmap(/*const*/ char* const* data, int x, int y, Fl_Color bg=FL_GRAY)
+{
+ return fl_draw_pixmap((const char*const*)data,x,y,bg);
+}
FL_EXPORT int fl_measure_pixmap(/*const*/ char* const* data, int &w, int &h);
FL_EXPORT int fl_measure_pixmap(const char* const* cdata, int &w, int &h);