ScummVM API documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Ultima::Ultima4::U4ImageDecoder Class Reference

#include <imageloader.h>

Inheritance diagram for Ultima::Ultima4::U4ImageDecoder:
Image::ImageDecoder Ultima::Ultima4::FMTOWNSImageDecoder Ultima::Ultima4::U4LzwImageDecoder Ultima::Ultima4::U4RawImageDecoder Ultima::Ultima4::U4RleImageDecoder

Public Member Functions

 U4ImageDecoder (int width, int height, int bpp)
 
void destroy () override
 
const Graphics::Surface * getSurface () const override
 
const Graphics::Palette & getPalette () const override
 
- Public Member Functions inherited from Image::ImageDecoder
virtual bool loadStream (Common::SeekableReadStream &stream)=0
 
virtual bool hasPalette () const
 
virtual bool hasTransparentColor () const
 
virtual uint32 getTransparentColor () const
 
virtual const Graphics::Surface * getMask () const
 
virtual bool hasMask () const
 

Protected Member Functions

void setFromRawData (const byte *rawData)
 
Graphics::PixelFormat getPixelFormatForBpp () const
 

Protected Attributes

Graphics::Surface * _surface
 
Graphics::Palette _palette
 
int _width
 
int _height
 
int _bpp
 

Detailed Description

A common base for all Ultima 4 image loaders.

Member Function Documentation

◆ destroy()

void Ultima::Ultima4::U4ImageDecoder::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.

◆ getSurface()

const Graphics::Surface* Ultima::Ultima4::U4ImageDecoder::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 Graphics::Palette& Ultima::Ultima4::U4ImageDecoder::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.

Returns
The decoded palette, or empty if no palette is present.

Implements Image::ImageDecoder.

◆ setFromRawData()

void Ultima::Ultima4::U4ImageDecoder::setFromRawData ( const byte *  rawData)
protected

Fill in the image pixel data from an uncompressed string of bytes.

◆ getPixelFormatForBpp()

Graphics::PixelFormat Ultima::Ultima4::U4ImageDecoder::getPixelFormatForBpp ( ) const
protected

Get the expected pixel format based on the value of _bpp.

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