ScummVM API documentation
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Public Member Functions | List of all members
Image::HNMFileDecoder Class Reference
Inheritance diagram for Image::HNMFileDecoder:
Image::ImageDecoder

Public Member Functions

 HNMFileDecoder (const Graphics::PixelFormat &format)
 
void destroy () override
 
bool loadStream (Common::SeekableReadStream &stream) override
 
const Graphics::Surface * getSurface () const override
 
- Public Member Functions inherited from Image::ImageDecoder
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
 

Member Function Documentation

◆ destroy()

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

◆ loadStream()

bool Image::HNMFileDecoder::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
streamInput stream.
Returns
Whether loading the file succeeded.
See also
getSurface
getPalette

Implements Image::ImageDecoder.

◆ getSurface()

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

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