IlvWBMPStreamer Class Reference

Bitmap streamer class. More...

#include <ilviews/bitmaps/wbmp.h>

Inheritance diagram for IlvWBMPStreamer:

List of all members.

Public Member Functions
	IlvWBMPStreamer ()
	Constructor.
IlBoolean	canRead () const
	Indicates that the instance can read from a stream.
IlBoolean	canWrite () const
	Indicates that the instance can write to a stream.
IlBoolean	checkSignature (const IlUChar *data, IlUInt size)
	Checks the signature of the input stream.
IlBoolean	isWhiteTransparent () const
	Gets whether white is treated as a transparent color when reading.
IlvBitmapData *	read (ILVSTDPREF istream &stream)
	Reads a WBMP image from a stream.
void	setWhiteTransparent (IlBoolean transp)
	Sets whether white is treated as a transparent color when reading.
IlBoolean	write (IlvBitmapData *data, ostream &stream)
	Writes an IlvBitmapData to a WBMP stream.

---

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,
		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.