diff options
author | Mattias Andrée <maandree@kth.se> | 2023-02-07 22:38:36 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2023-02-07 22:38:36 +0100 |
commit | 6bea61a199dd841b23053cf1b8ccd3dd753c0846 (patch) | |
tree | 62e526e51eac4b210305177dcc5222e800d42d35 /rtgrpblib_set_draftness.3 | |
parent | README: add usage information (diff) | |
download | librifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket-6bea61a199dd841b23053cf1b8ccd3dd753c0846.tar.gz librifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket-6bea61a199dd841b23053cf1b8ccd3dd753c0846.tar.bz2 librifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket-6bea61a199dd841b23053cf1b8ccd3dd753c0846.tar.xz |
Add man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'rtgrpblib_set_draftness.3')
-rw-r--r-- | rtgrpblib_set_draftness.3 | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/rtgrpblib_set_draftness.3 b/rtgrpblib_set_draftness.3 new file mode 100644 index 0000000..43fd83f --- /dev/null +++ b/rtgrpblib_set_draftness.3 @@ -0,0 +1,42 @@ +.TH RTGRPBLIB_SET_DRAFTNESS 3 LIBRIFUNKTIONSTECKENSNITTSGLYFRASTERISERINGSPROGRAMBIBLIOTEKET +.SH NAME +rtgrpblib_set_draftness - Reconfigure a drawing buffer with a new draftness value + +.SH DESCRIPTION +.LP +.nf +#include <librifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket.h> + +void rtgrpblib_set_draftness(RTGRPBLIB_RASTER *\fIraster\fP, double \fIdraftness\fP); +.fi +.PP +Link with +.IR "-lrifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket" . + +.SH DESCRIPTION +The +.BR rtgrpblib_set_draftness () +function changes that draftness value of drawing buffer +.I raster +to the value specified in the +.I draftness +parameter. The value must be positive, and shall not be +unreasonably small, lest drawing functions may get stuck. +The default value is 0.5. +.PP +When drawing a curve, the size of each step the library +takes will be proportional to the draftness value, but +will also depend on other factors. Doubling the draftness +value with halve (disregarind overheads) the time it takes +to draw any given curve. + +.SH RETURN VALUES +None. + +.SH ERRORS +None. + +.SH SEE ALSO +.BR librifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket (7), +.BR rtgrpblib_create_raster (3), +.BR rtgrpblib_fill_shapes (3) |