decompress.h File Reference

wraps the bios decompress functionality into something a bit easier to deal with. More...

#include <nds/ndstypes.h>
#include <nds/bios.h>

Enumerations
enum	DecompressType {   LZ77,   LZ77Vram,   HUFF,   RLE,   RLEVram }
	the types of decompression available. More...
Functions
void	decompress (const void *data, void *dst, DecompressType type)
	decompresses data using the suported type
void	decompressStream (const void *data, void *dst, DecompressType type, getByteCallback readCB, getHeaderCallback getHeaderCB)
	decompresses data using the suported type (only LZ77Vram, HUFF, and RLEVram support streaming)

---

Detailed Description

wraps the bios decompress functionality into something a bit easier to deal with.

---

Enumeration Type Documentation

enum DecompressType

the types of decompression available.

Enumerator:

LZ77	LZ77 decompression.
LZ77Vram	vram safe LZ77 decompression.
HUFF	vram safe huff decompression.
RLE	run length encoded decompression.
RLEVram	vram safe run length encoded decompression.

---

Function Documentation

void decompress	(	const void *	data,
		void *	dst,
		DecompressType	type
	)

decompresses data using the suported type

Parameters:

	dst	the destination to decompress to
	data	the data to decompress
	type	the type of data to decompress

Examples:

Graphics/Backgrounds/16bit_color_bmp/source/template.cpp.

void decompressStream	(	const void *	data,
		void *	dst,
		DecompressType	type,
		getByteCallback	readCB,
		getHeaderCallback	getHeaderCB
	)

decompresses data using the suported type (only LZ77Vram, HUFF, and RLEVram support streaming)

Parameters:

	dst	the destination to decompress to.
	data	the data to decompress.
	type	the type of data to decompress.
	readCB	a callback to read the next byte of data.
	getHeaderCB	a callback to read the 32 byte header.