aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 7c9c913e5ae0023ece2f252153068f4886469f48 (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
42
43
44
45
46
47
48
49
50
NAME
	liblss16 - Library for the SYSLINUX "ad hoc" LSS16 image format

DESCRIPTION
	liblss16 is a C library for encoding and decode the LSS16 image file
	format, which is a SYSLINUX "ad hoc" lossless, compressed, low-fidelity
	image file format optimised bootloaders in low-end graphics
	environments.

	liblss16 provides the following functions for decoding LSS16 images:

		liblss16_decoder_init(3)
			Prepare state for liblss16_decode_to_colour_index(3).

		liblss16_decode_to_colour_index(3)
			Decode an file. The colour of each pixel is output with
			the index of the colour in the colour palette.

		liblss16_decode_strerror(3)
			Get error description for error code returned by
			liblss16_decode_to_colour_index(3).

	liblss16 provides the following functions for encoding LSS16 images:

		liblss16_optimise(3)
			Optimise an image for optimal compression with LSS16.

		liblss16_encoder_init(3)
			Prepare state for liblss16_encode_from_colour_index(3).

		liblss16_encode_from_colour_index(3)
			Encode an file. The colour of each pixle is input as the
			index of the colour in the colour palette.

		liblss16_encode_strerror(3)
			Get error description for error code returned by
			liblss16_encoder_init(3) or
			liblss16_encode_from_colour_index(3).

EXTENDED DESCRIPTION
	The liblss16 project also implements the following utilities:

	lss16toppm(1)
		Convert an LSS16 file to a Portable Pixmap (PPM) file.

	ppmtolss16(1)
		Convert a Portable Anymap (PNM) file to an LSS16 file.

SEE ALSO
	lss16(5), syslinux(1)