IlvWBMPStreamer Class Reference

Bitmap streamer class. More...

#include <ilviews/bitmaps/wbmp.h>

Inheritance diagram for IlvWBMPStreamer:

Public Member Functions
	IlvWBMPStreamer ()
	Constructor.
IlBoolean	canRead () const
	Indicates that the instance can read from a stream. More...
IlBoolean	canWrite () const
	Indicates that the instance can write to a stream. More...
IlBoolean	checkSignature (const IlUChar *data, IlUInt size)
	Checks the signature of the input stream. More...
IlBoolean	isWhiteTransparent () const
	Gets whether white is treated as a transparent color when reading. More...
IlvBitmapData *	read (ILVSTDPREF istream &stream)
	Reads a WBMP image from a stream. More...
void	setWhiteTransparent (IlBoolean transp)
	Sets whether white is treated as a transparent color when reading. More...
IlBoolean	write (IlvBitmapData *data, IL_STDPREF ostream &stream)
	Writes an IlvBitmapData to a WBMP stream. More...
Public Member Functions inherited from IlvBitmapStreamer
virtual void	callReadProgressCallback (IlUInt current, IlUInt max)
	Calls the callback for read progression. More...
virtual void	callWriteProgressCallback (IlUInt current, IlUInt max)
	Calls the callback for write progression. More...
virtual const char *	getName () const
	Returns the internal name of the streamer. More...
IlvQuantizer *	getQuantizer () const
	Returns the quantizer used by this streamer. More...
virtual IlvBitmapData *	read (IL_STDPREF istream &stream)
	Reads from a stream. More...
virtual IlvBitmapInformation *	readInfo (IL_STDPREF istream &stream)
	Reads information from a stream. More...
void	setQuantizer (IlvQuantizer *quantizer)
	Sets the quantizer used (if needed) by this streamer. More...
virtual void	setReadProgressCallback (IlvProgressCallback rCallback, IlAny arg=0)
	Sets the callback for read progression. More...
virtual void	setWriteProgressCallback (IlvProgressCallback wCallback, IlAny arg=0)
	Sets the callback for write progression. More...
virtual	~IlvBitmapStreamer ()
	Reads a bitmap using the registered streamers. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvBitmapStreamer
static void	Register (IlvBitmapStreamer *streamer)
	Registers the given streamer. More...
static IlBoolean	UnRegister (IlvBitmapStreamer *streamer)
	Unregisters the given streamer. More...
static IlvBitmapStreamer *	Get (const char *name)
	Reads a bitmap using the registered streamers. More...
static IlvBitmap *	Read (IlvDisplay *display, IL_STDPREF istream &stream, const IlUChar *signature, IlUInt signatureLen)
	Reads a bitmap using the registered streamers. More...
static IlvBitmapData *	ReadBitmapData (IL_STDPREF istream &stream, const IlUChar *signature, IlUInt signatureLen)
	Reads bitmap data using the registered streamers. More...
static IlvBitmapInformation *	ReadInfo (IL_STDPREF istream &stream, const IlUChar *signature, IlUInt signatureLen)
	Reads bitmap information using the registered streamers. More...
static IlvBitmapStreamer **	GetRegisteredStreamers (IlUInt &count)
	Returns the registered streamers. More...
static IlBoolean	CheckInModules (const IlUChar *sigbuffer, const IlUChar *filename=0)
	Reads a bitmap using the registered streamers. More...
static	IlListOf (IlvBitmapStreamers)*_Streamers
	Reads a bitmap using the registered streamers. More...
Protected Member Functions inherited from IlvBitmapStreamer
	IlvBitmapStreamer ()
	Reads a bitmap using the registered streamers. More...
Protected Attributes inherited from IlvBitmapStreamer
IlvProgressCallback	_readProgressCallback
	Reads a bitmap using the registered streamers. More...
IlAny	_argr
	Reads a bitmap using the registered streamers. More...
IlvProgressCallback	_writeProgressCallback
	Reads a bitmap using the registered streamers. More...
IlAny	_argw
	Reads a bitmap using the registered streamers. More...
IlvQuantizer *	_quantizer
	Reads a bitmap using the registered streamers. More...

Detailed Description

Bitmap streamer class.

Library: display

This streamer provides methods to deal with a stream containing a WBMP image. It supports reading from type 0 images.
This streamer can read and write.
When reading or writing, callbacks will be called at each scanline.

Member Function Documentation

IlBoolean IlvWBMPStreamer::canRead ( ) const

virtual

Indicates that the instance can read from a stream.

Returns

IlTrue.

Reimplemented from IlvBitmapStreamer.

IlBoolean IlvWBMPStreamer::canWrite ( ) const

virtual

Indicates that the instance can write to a stream.

Returns

IlTrue.

Reimplemented from IlvBitmapStreamer.

IlBoolean IlvWBMPStreamer::checkSignature ( const IlUChar *  data, IlUInt  size  )

virtual

Checks the signature of the input stream.

Parameters

data	The data containing the signature of the stream.
size	The size of the data containing the signature.

Returns

IlTrue if the data contains a WBMP signature.

Implements IlvBitmapStreamer.

IlBoolean IlvWBMPStreamer::isWhiteTransparent

(

)

const

Gets whether white is treated as a transparent color when reading.

Returns

IlTrue if white is transparent.

IlvBitmapData* IlvWBMPStreamer::read

(

ILVSTDPREF istream &

stream

)

Reads a WBMP image from a stream.

Parameters

stream

The stream to read from.

Returns

An instance of IlvBitmapData.

void IlvWBMPStreamer::setWhiteTransparent

(

IlBoolean

transp

)

Sets whether white is treated as a transparent color when reading.

Parameters

transp

IlTrue if white is transparent.

IlBoolean IlvWBMPStreamer::write ( IlvBitmapData *  data, IL_STDPREF ostream &  stream  )

virtual

Writes an IlvBitmapData to a WBMP stream.

Parameters

data	The bitmap data to write.
stream	The stream to write to.

Returns

IlTrue if the bitmap data has been written.

Reimplemented from IlvBitmapStreamer.