aboutsummaryrefslogtreecommitdiffstats
path: root/libquanta.7
diff options
context:
space:
mode:
Diffstat (limited to 'libquanta.7')
-rw-r--r--libquanta.755
1 files changed, 55 insertions, 0 deletions
diff --git a/libquanta.7 b/libquanta.7
new file mode 100644
index 0000000..d68b73e
--- /dev/null
+++ b/libquanta.7
@@ -0,0 +1,55 @@
+.TH LIBQUANTA 7 libquanta
+.SH NAME
+libquanta \- Colour quantisation library
+
+.SH SYNPOSIS
+.nf
+#include <libquanta.h>
+.fi
+.PP
+Link with
+.I -lquanta
+.IR -lm .
+
+.SH DESCRIPTION
+The
+.B libquanta
+software library is a C library for colour quantisation
+of images, meaning it lets you create a colour palette for
+an image and convert the image to a palette-based image.
+.PP
+The palette may have lower colour resolution and fewer
+colours than the original image.
+.PP
+.B libquanta
+is not designed to convert an image to a palette-based
+image based on a pre-existing palette. It is only designed
+to create a palette suitable for a provided image.
+.PP
+The
+.B libquanta
+software library implements the following functions:
+
+.SS Colour palette functions
+.TP
+.BR libquanta_palette_size (3)
+Calculate the size of a colour palette.
+.TP
+.BR libquanta_malloc_palette (3)
+Allocate a colour palette.
+
+.SS Colour quantisation functions
+.TP
+.BR libquanta_quantise (3),
+.TQ
+.BR libquanta_vquantise (3)
+Colour-quantise an image using an algorithm selected by the library.
+.TP
+.TP
+.BR libquanta_quantise_wu (3),
+.TQ
+.BR libquanta_vquantise_wu (3)
+Colour-quantise an image using Wu's Colour Quantiser.
+
+.SH SEE ALSO
+None.