aboutsummaryrefslogtreecommitdiffstats
path: root/liblss16_decoder_init.3
diff options
context:
space:
mode:
Diffstat (limited to 'liblss16_decoder_init.3')
-rw-r--r--liblss16_decoder_init.341
1 files changed, 41 insertions, 0 deletions
diff --git a/liblss16_decoder_init.3 b/liblss16_decoder_init.3
new file mode 100644
index 0000000..262fc07
--- /dev/null
+++ b/liblss16_decoder_init.3
@@ -0,0 +1,41 @@
+.TH LIBLSS16_DECODER_INIT 3 LIBLSS16
+.SH NAME
+liblss16_decoder_init \- Prepare state for decoding LSS16 image file
+
+.SH SYNOPSIS
+.nf
+#include <liblss16.h>
+
+struct liblss16_decoder { /* fields omitted */ };
+
+void liblss16_decoder_init(struct liblss16_decoder *\fIdecoder\fP);
+.fi
+.PP
+Link with
+.IR -llss16 .
+
+.SH DESCRIPTION
+The
+.BR liblss16_decoder_init ()
+function initialises
+.I *decoder
+for the first call to the
+.BR liblss16_decode_to_colour_index (3)
+function.
+.PP
+.I decoder
+must not be
+.IR NULL .
+.PP
+There is no corresponding deallocator as no dynamic resources are allocated.
+
+.SH RETURN VALUE
+None.
+
+.SH ERRORS
+The
+.BR liblss16_decoder_init ()
+function cannot fail.
+
+.SH SEE ALSO
+.BR liblss16 (7)