aboutsummaryrefslogtreecommitdiffstats
path: root/liblss16_decoder_init.3
blob: 262fc0760fd544dedc4f9b660c60d4b6ddb08d14 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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)