Common::PackBitsReadStream Class Reference

#include <iff_container.h>

Inheritance diagram for Common::PackBitsReadStream:

Public Member Functions
	PackBitsReadStream (Common::ReadStream &input)
virtual bool	eos () const
uint32	read (void *dataPtr, uint32 dataSize)
Public Member Functions inherited from Common::ReadStream
byte	readByte ()
FORCEINLINE int8	readSByte ()
uint16	readUint16LE ()
uint32	readUint32LE ()
uint64	readUint64LE ()
uint16	readUint16BE ()
uint32	readUint32BE ()
uint64	readUint64BE ()
FORCEINLINE int16	readSint16LE ()
FORCEINLINE int32	readSint32LE ()
FORCEINLINE int64	readSint64LE ()
FORCEINLINE int16	readSint16BE ()
FORCEINLINE int32	readSint32BE ()
FORCEINLINE int64	readSint64BE ()
FORCEINLINE float	readFloatLE ()
FORCEINLINE float	readFloatBE ()
FORCEINLINE double	readDoubleLE ()
FORCEINLINE double	readDoubleBE ()
template<class TDataFormat , class... T>
bool	readMultiple (const TDataFormat &dataFormat, T &...values)
template<class... T>
bool	readMultipleEndian (bool isLittle, T &...values)
template<class... T>
bool	readMultipleLE (T &...values)
template<class... T>
bool	readMultipleBE (T &...values)
SeekableReadStream *	readStream (uint32 dataSize)
String	readString (char terminator=0, size_t len=String::npos)
Common::String	readPascalString (bool transformCR=true)
Public Member Functions inherited from Common::Stream
virtual bool	err () const
virtual void	clearErr ()

Protected Attributes
Common::ReadStream *	_input

Detailed Description

Decode a given PackBits encoded stream.

PackBits is an RLE compression algorithm introduced by Apple. It is also used to encode ILBM and PBM subtypes of IFF files, and some flavors of TIFF.

As there is no compression across row boundaries in the above formats, read() will extract a new line on each call, discarding any alignment or padding.

Member Function Documentation

eos()

virtual bool Common::PackBitsReadStream::eos ( ) const

virtual

Return true if a read failed because the stream end has been reached.

This flag is cleared by clearErr(). For a SeekableReadStream, the flag is also cleared by a successful seek.

Note

The semantics of any implementation of this method is supposed to match that of ISO C feof(). In particular, in a stream with N bytes, reading exactly N bytes from the start should not set eos; only reading beyond the available data should set it.

Implements Common::ReadStream.

read()

uint32 Common::PackBitsReadStream::read ( void *  dataPtr, uint32  dataSize  )

virtual

Read data from the stream.

Subclasses must implement this method. All other read methods are implemented using it.

Note

The semantics of any implementation of this method is supposed to match that of ISO C fread(), in particular where it concerns setting error and end of file/stream flags.

Parameters

dataPtr	Pointer to a buffer into which the data is read.
dataSize	Number of bytes to be read.

Returns

The number of bytes that were actually read.

Implements Common::ReadStream.

---

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

• common/formats/iff_container.h