Image::GIFDecoder Class Reference

Inheritance diagram for Image::GIFDecoder:

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

Member Function Documentation

loadStream()

bool Image::GIFDecoder::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.

destroy()

void Image::GIFDecoder::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.

getPalette()

const byte* Image::GIFDecoder::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::GIFDecoder::getPaletteColorCount ( ) const

inlineoverridevirtual

Return the number of colors in the palette.

Reimplemented from Image::ImageDecoder.

getSurface()

const Graphics::Surface* Image::GIFDecoder::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.

hasTransparentColor()

bool Image::GIFDecoder::hasTransparentColor ( ) const

inlineoverridevirtual

Query whether the decoded image has a transparent color.

Reimplemented from Image::ImageDecoder.

getTransparentColor()

uint32 Image::GIFDecoder::getTransparentColor ( ) const

inlineoverridevirtual

Return the transparent color.

Reimplemented from Image::ImageDecoder.

---

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

• image/gif.h