Image::XBMDecoder Class Reference

Inheritance diagram for Image::XBMDecoder:

Public Member Functions
void	destroy () override
bool	loadStream (Common::SeekableReadStream &stream) override
const Graphics::Surface *	getSurface () const override
const byte *	getPalette () const override
uint16	getPaletteColorCount () const override
bool	loadBits (const unsigned char *bits, int width, int height)
Public Member Functions inherited from Image::ImageDecoder
virtual bool	hasPalette () const
virtual bool	hasTransparentColor () const
virtual uint32	getTransparentColor () const

Member Function Documentation

destroy()

void Image::XBMDecoder::destroy ( )

overridevirtual

Destroy this decoder's surface and palette.

This should be called by a loadStream() implementation as well as by the destructor.

Implements Image::ImageDecoder.

loadStream()

bool Image::XBMDecoder::loadStream ( Common::SeekableReadStream &  stream )

overridevirtual

Load an image from the specified stream.

loadStream() should implicitly call destroy() to free the memory of the last loadStream() call.

Parameters

stream

Input stream.

Returns

Whether loading the file succeeded.

See also

getSurface

getPalette

Implements Image::ImageDecoder.

getSurface()

const Graphics::Surface* Image::XBMDecoder::getSurface ( ) const

inlineoverridevirtual

Get the decoded surface.

This surface is owned by this ImageDecoder and remains valid until destroy() or loadStream() is called, or until the destructor of this ImageDecoder is called.

Returns

The decoded surface, or 0 if no surface is present.

Implements Image::ImageDecoder.

getPalette()

const byte* Image::XBMDecoder::getPalette ( ) const

inlineoverridevirtual

Get the decoded palette.

This palette is owned by this ImageDecoder and remains valid until destroy() or loadStream() is called, or until the destructor of this ImageDecoder is called.

The format of the palette is the same as that of the PaletteManager's palette. (interleaved RGB values).

Returns

The decoded palette, or undefined if no palette is present.

Reimplemented from Image::ImageDecoder.

getPaletteColorCount()

uint16 Image::XBMDecoder::getPaletteColorCount ( ) const

inlineoverridevirtual

Return the number of colors in the palette.

Reimplemented from Image::ImageDecoder.

loadBits()

bool Image::XBMDecoder::loadBits	(	const unsigned char *	bits,
		int	width,
		int	height
	)

Load an image from an embedded XBM file.

loadStream() should implicitly call destroy() to free the memory of the last loadStream() call.

Parameters

bits	Image data.
width	Image width.
height	Image height.

Returns

Whether loading the image succeeded.

See also

getSurface

---

The documentation for this class was generated from the following file:

• image/xbm.h