summaryrefslogtreecommitdiff
path: root/desktop/plotters.h
diff options
context:
space:
mode:
authorJohn Mark Bell <jmb@netsurf-browser.org>2011-01-09 00:02:47 +0000
committerJohn Mark Bell <jmb@netsurf-browser.org>2011-01-09 00:02:47 +0000
commit3368407d9eb0fa10db910e2f7f054983fe56c31c (patch)
tree6bc3dacfd952a10892a357a1e7f7d7605ad7590b /desktop/plotters.h
parent6b544e94b9713ecc9b1863dd3177ced97b859f90 (diff)
downloadnetsurf-3368407d9eb0fa10db910e2f7f054983fe56c31c.tar.gz
netsurf-3368407d9eb0fa10db910e2f7f054983fe56c31c.tar.bz2
Document font APIs -- specifically, string lengths are specified in bytes, not characters
svn path=/trunk/netsurf/; revision=11261
Diffstat (limited to 'desktop/plotters.h')
-rw-r--r--desktop/plotters.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/desktop/plotters.h b/desktop/plotters.h
index 4edec321b..076baf242 100644
--- a/desktop/plotters.h
+++ b/desktop/plotters.h
@@ -114,7 +114,16 @@ struct plotter_table {
struct bitmap *bitmap, colour bg,
bitmap_flags_t flags);
- /* text */
+ /**
+ * Text.
+ *
+ * \param x x coordinate
+ * \param y y coordinate
+ * \param text UTF-8 string to plot
+ * \param length length of string, in bytes
+ * \param fstyle plot style for this text
+ * \return true on success, false on error and error reported
+ */
bool (*text)(int x, int y, const char *text, size_t length,
const plot_font_style_t *fstyle);