ScummVM API documentation
Image::CinepakDecoder Class Reference

#include <cinepak.h>

Inheritance diagram for Image::CinepakDecoder:
Image::Codec

Public Member Functions

 CinepakDecoder (int bitsPerPixel=24)
 
const Graphics::SurfacedecodeFrame (Common::SeekableReadStream &stream) override
 
Graphics::PixelFormat getPixelFormat () const override
 
bool setOutputPixelFormat (const Graphics::PixelFormat &format) override
 
bool containsPalette () const override
 
const byte * getPalette () override
 
bool hasDirtyPalette () const override
 
bool canDither (DitherType type) const override
 
void setDither (DitherType type, const byte *palette) override
 

Additional Inherited Members

- Public Types inherited from Image::Codec
enum  DitherType { kDitherTypeUnknown, kDitherTypeVFW, kDitherTypeQT }
 
- Static Public Member Functions inherited from Image::Codec
static byte * createQuickTimeDitherTable (const byte *palette, uint colorCount)
 

Detailed Description

Cinepak decoder.

Used by BMP/AVI and PICT/QuickTime.

Used in engines:

  • sherlock

Member Function Documentation

◆ decodeFrame()

const Graphics::Surface* Image::CinepakDecoder::decodeFrame ( Common::SeekableReadStream stream)
overridevirtual

Decode the frame for the given data and return a pointer to a surface containing the decoded frame.

Returns
a pointer to the decoded frame

Implements Image::Codec.

◆ getPixelFormat()

Graphics::PixelFormat Image::CinepakDecoder::getPixelFormat ( ) const
inlineoverridevirtual

Get the format that the surface returned from decodeImage() will be in.

Implements Image::Codec.

◆ setOutputPixelFormat()

bool Image::CinepakDecoder::setOutputPixelFormat ( const Graphics::PixelFormat format)
overridevirtual

Select the preferred format to use, for codecs where this is faster than converting the image afterwards. Returns true if supported, and false otherwise.

Reimplemented from Image::Codec.

◆ containsPalette()

bool Image::CinepakDecoder::containsPalette ( ) const
inlineoverridevirtual

Can this codec's frames contain a palette?

Reimplemented from Image::Codec.

◆ getPalette()

const byte* Image::CinepakDecoder::getPalette ( )
inlineoverridevirtual

Get the palette last decoded from decodeImage

Reimplemented from Image::Codec.

◆ hasDirtyPalette()

bool Image::CinepakDecoder::hasDirtyPalette ( ) const
inlineoverridevirtual

Does the codec have a dirty palette?

Reimplemented from Image::Codec.

◆ canDither()

bool Image::CinepakDecoder::canDither ( DitherType  type) const
overridevirtual

Can the codec dither down to 8bpp?

Reimplemented from Image::Codec.

◆ setDither()

void Image::CinepakDecoder::setDither ( DitherType  type,
const byte *  palette 
)
overridevirtual

Activate dithering mode with a palette

Reimplemented from Image::Codec.


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