Image::PCXDecoder Class Reference

Inheritance diagram for Image::PCXDecoder:

Public Member Functions
void	destroy ()
virtual bool	loadStream (Common::SeekableReadStream &stream)
virtual const Graphics::Surface *	getSurface () const
const byte *	getPalette () const
uint16	getPaletteColorCount () const
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::PCXDecoder::destroy ( )

virtual

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()

virtual bool Image::PCXDecoder::loadStream ( Common::SeekableReadStream &  stream )

virtual

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()

virtual const Graphics::Surface* Image::PCXDecoder::getSurface ( ) const

inlinevirtual

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::PCXDecoder::getPalette ( ) const

inlinevirtual

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::PCXDecoder::getPaletteColorCount ( ) const

inlinevirtual

Return the number of colors in the palette.

Reimplemented from Image::ImageDecoder.

---

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

• image/pcx.h