lod Namespace Reference

Functions
bool	detect (const Blob &data)
LodFont	decodeFont (const Blob &blob)
bool	detectCompressedData (const Blob &blob)
bool	detectCompressedPseudoImage (const Blob &blob)
bool	detectImage (const Blob &blob, bool *isPalette=nullptr)
bool	detectSprite (const Blob &blob)
bool	detectFont (const Blob &blob)
Blob	decodeCompressedData (const Blob &blob)
Blob	decodeCompressedPseudoImage (const Blob &blob)
Blob	decodeMaybeCompressed (const Blob &blob)
Blob	encodeCompressed (const Blob &blob)
Palette	decodePalette (const Blob &blob)
LodImage	decodeImage (const Blob &blob)
Sizei	decodeImageSize (const Blob &blob)
LodSprite	decodeSprite (const Blob &blob)

Function Documentation

decodeCompressedData()

Blob lod::decodeCompressedData

(

const Blob &

blob

)

This function processes compressed lod data.

Parameters

blob	Blob from a LOD file.

Returns

Uncompressed Palette.

Exceptions

Exception

If the format is not recognized.

decodeCompressedPseudoImage()

Blob lod::decodeCompressedPseudoImage

(

const Blob &

blob

)

This function processes compressed lod pseudo-images.

Parameters

blob	Blob from a LOD file.

Returns

Uncompressed Palette.

Exceptions

Exception

If the format is not recognized.

decodeFont()

LodFont lod::decodeFont

(

const Blob &

blob

)

This function processes lod fonts.

Parameters

blob	Font blob, as read from a LOD file.

Returns

Decoded LodFont.

Exceptions

Exception

If the format is not recognized.

decodeImage()

LodImage lod::decodeImage

(

const Blob &

blob

)

This function processes lod images and lod palettes. In case of the latter, the pixel data will be empty.

Parameters

blob	Image Blob, as read from a LOD file.

Returns

Decoded LodImage.

Exceptions

Exception

If the format is not recognized.

decodeImageSize()

Sizei lod::decodeImageSize

(

const Blob &

blob

)

This function processes lod images and lod palettes. It reads the image header and returns image size w/o decompressing the pixel data. For lod palettes returned image size will be zero.

Parameters

blob	Image Blob, as read from a LOD file.

Returns

Image size.

Exceptions

Exception

If the format is not recognized.

decodeMaybeCompressed()

Blob lod::decodeMaybeCompressed

(

const Blob &

blob

)

This functions processes compressed lod data, and compressed lod pseudo-images.

For everything else it just does nothing and returns the blob as is.

Parameters

blob	Blob from a LOD file.

Returns

Uncompressed Blob.

Exceptions

Exception

If the format is not recognized.

decodePalette()

Palette lod::decodePalette

(

const Blob &

blob

)

This function processes lod images and lod palettes. In case of the former, the pixel data is ignored.

Parameters

blob	Blob from a LOD file.

Returns

Decoded Palette.

Exceptions

Exception

If the format is not recognized.

decodeSprite()

LodSprite lod::decodeSprite

(

const Blob &

blob

)

This function processes lod sprites.

Parameters

blob	Sprite blob, as read from a LOD file.

Returns

Decoded LodSprite.

Exceptions

Exception

If the format is not recognized.

detect()

bool lod::detect

(

const Blob &

data

)

detectCompressedData()

bool lod::detectCompressedData

(

const Blob &

blob

)

detectCompressedPseudoImage()

bool lod::detectCompressedPseudoImage

(

const Blob &

blob

)

detectFont()

bool lod::detectFont

(

const Blob &

blob

)

detectImage()

bool lod::detectImage	(	const Blob &	blob,
		bool *	isPalette = nullptr
	)

detectSprite()

bool lod::detectSprite

(

const Blob &

blob

)

encodeCompressed()

Blob lod::encodeCompressed

(

const Blob &

blob

)

This function compresses the provided Blob into the compressed lod data format.

Parameters

blob	Blob to compress.

Returns

Compressed Blob.