Image::ImageDecoder Class Reference

#include <image_decoder.h>

Inheritance diagram for Image::ImageDecoder:

Public Member Functions
virtual bool	loadStream (Common::SeekableReadStream &stream)=0
virtual void	destroy ()=0
virtual const Graphics::Surface *	getSurface () const =0
virtual const byte *	getPalette () const
virtual bool	hasPalette () const
virtual uint16	getPaletteColorCount () const
virtual bool	hasTransparentColor () const
virtual uint32	getTransparentColor () const
virtual const Graphics::Surface *	getMask () const
virtual bool	hasMask () const

Detailed Description

A representation of an image decoder that maintains ownership of the surface and palette it decodes to.

This is designed for still frames only.

Member Function Documentation

loadStream()

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

pure 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

Implemented in Image::IFFDecoder, Image::BitmapDecoder, Image::TGADecoder, Director::BITDDecoder, Ultima::Ultima4::U4LzwImageDecoder, Image::PICTDecoder, Image::PNGDecoder, Image::Cel3DODecoder, Image::PCXDecoder, Image::JPEGDecoder, Ultima::Ultima4::U4RleImageDecoder, Image::ScrDecoder, Image::NeoDecoder, Director::DIBDecoder, Image::HNMFileDecoder, Image::CicnDecoder, Image::HLZFileDecoder, Image::XBMDecoder, Supernova::MSNImage, MM::MM1::Gfx::ScreenDecoder, Prince::MhwanhDecoder, Ultima::Ultima4::U4RawImageDecoder, Ultima::Ultima4::FMTOWNSImageDecoder, Sludge::HSIDecoder, and Image::DoodleDecoder.

destroy()

virtual void Image::ImageDecoder::destroy ( )

pure virtual

Destroy this decoder's surface and palette.

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

Implemented in Image::IFFDecoder, Image::BitmapDecoder, Image::TGADecoder, Director::BITDDecoder, Image::PICTDecoder, Image::PNGDecoder, Image::Cel3DODecoder, Image::PCXDecoder, Image::JPEGDecoder, Image::ScrDecoder, Image::NeoDecoder, Director::DIBDecoder, Image::HNMFileDecoder, Image::CicnDecoder, Image::HLZFileDecoder, Image::XBMDecoder, Supernova::MSNImage, Ultima::Ultima4::U4ImageDecoder, MM::MM1::Gfx::ScreenDecoder, Prince::MhwanhDecoder, Sludge::HSIDecoder, and Image::DoodleDecoder.

getSurface()

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

pure virtual

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.

Implemented in Image::IFFDecoder, Image::BitmapDecoder, Director::BITDDecoder, Image::TGADecoder, Image::PICTDecoder, Image::PNGDecoder, Image::Cel3DODecoder, Image::PCXDecoder, Image::JPEGDecoder, Image::ScrDecoder, Image::NeoDecoder, Director::DIBDecoder, Image::HNMFileDecoder, MM::MM1::Gfx::ScreenDecoder, Image::CicnDecoder, Image::HLZFileDecoder, Image::XBMDecoder, Supernova::MSNImage, Ultima::Ultima4::U4ImageDecoder, Prince::MhwanhDecoder, Sludge::HSIDecoder, and Image::DoodleDecoder.

getPalette()

virtual const byte* Image::ImageDecoder::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 in Image::IFFDecoder, Image::BitmapDecoder, Director::BITDDecoder, Image::TGADecoder, Image::PICTDecoder, Image::PNGDecoder, Image::Cel3DODecoder, Image::PCXDecoder, Image::NeoDecoder, MM::MM1::Gfx::ScreenDecoder, Director::DIBDecoder, Image::CicnDecoder, Image::HLZFileDecoder, Image::XBMDecoder, Supernova::MSNImage, Ultima::Ultima4::U4ImageDecoder, Prince::MhwanhDecoder, and Image::DoodleDecoder.

hasPalette()

virtual bool Image::ImageDecoder::hasPalette ( ) const

inlinevirtual

Query whether the decoded image has a palette.

getPaletteColorCount()

virtual uint16 Image::ImageDecoder::getPaletteColorCount ( ) const

inlinevirtual

Return the number of colors in the palette.

Reimplemented in Image::IFFDecoder, Image::BitmapDecoder, Director::BITDDecoder, Image::TGADecoder, Image::PICTDecoder, Image::PNGDecoder, Image::Cel3DODecoder, Image::PCXDecoder, Image::NeoDecoder, Director::DIBDecoder, MM::MM1::Gfx::ScreenDecoder, Image::CicnDecoder, Image::HLZFileDecoder, Image::XBMDecoder, Ultima::Ultima4::U4ImageDecoder, and Image::DoodleDecoder.

hasTransparentColor()

virtual bool Image::ImageDecoder::hasTransparentColor ( ) const

inlinevirtual

Query whether the decoded image has a transparent color.

Reimplemented in Image::PNGDecoder.

getTransparentColor()

virtual uint32 Image::ImageDecoder::getTransparentColor ( ) const

inlinevirtual

Return the transparent color.

Reimplemented in Image::PNGDecoder.

getMask()

virtual const Graphics::Surface* Image::ImageDecoder::getMask ( ) const

inlinevirtual

Get the mask data for the decoded image.

Reimplemented in Image::CicnDecoder.

hasMask()

virtual bool Image::ImageDecoder::hasMask ( ) const

inlinevirtual

Query whether the decoded image has a mask.

---

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

• image/image_decoder.h