ScummVM API documentation
SCR decoder

Description

Decoder for ZX-Spectrum SCREEN$ based on: https://gist.github.com/alexanderk23/f459c76847d9412548f7.

Used in engines:

Namespaces

 Common
 

Classes

class  Image::ScrDecoder
 

Functions

void Image::ScrDecoder::destroy ()
 
virtual bool Image::ScrDecoder::loadStream (Common::SeekableReadStream &stream)
 
virtual const Graphics::SurfaceImage::ScrDecoder::getSurface () const
 

Function Documentation

◆ destroy()

void Image::ScrDecoder::destroy ( )
virtual

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()

virtual bool Image::ScrDecoder::loadStream ( Common::SeekableReadStream stream)
virtual

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()

virtual const Graphics::Surface* Image::ScrDecoder::getSurface ( ) const
inlinevirtual

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.