IlvJPGStreamer Class Reference

Bitmap streamer class. More...

#include <ilviews/bitmaps/jpg.h>

Inheritance diagram for IlvJPGStreamer:

List of all members.

Public Member Functions
	IlvJPGStreamer ()
	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.
IlUInt	getQuality () const
	Gets the quality of the generated JPEG stream when writing.
IlBoolean	isProgressive () const
	Gets whether the generated JPEG stream is progressive.
IlvBitmapData *	read (ILVSTDPREF istream &stream)
	Reads a JPEG image from a stream.
void	setProgressive (IlBoolean progressive)
	Sets whether the generated JPEG stream is progressive.
void	setQuality (IlUInt quality)
	Sets the quality of the generated JPEG stream.
IlBoolean	write (IlvBitmapData *data, ILVSTDPREF ostream &stream)
	Writes an IlvBitmapDatato a JPEG stream.

---

Detailed Description

Bitmap streamer class.

Library: display

This streamer provides methods to deal with a stream containing a JPEG image. It supports reading from grayscale or true color and progressive and non-progressive JPEG streams.
This streamer can read and write.
When reading or writing, callbacks will be called at each scanline.

---

Member Function Documentation

IlBoolean IlvJPGStreamer::canRead

(

)

const [virtual]

Indicates that the instance can read from a stream.

Returns:

IlTrue.

Reimplemented from IlvBitmapStreamer.

IlBoolean IlvJPGStreamer::canWrite

(

)

const [virtual]

Indicates that the instance can write to a stream.

Returns:

IlTrue.

Reimplemented from IlvBitmapStreamer.

IlBoolean IlvJPGStreamer::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 JPEG signature.

Implements IlvBitmapStreamer.

IlUInt IlvJPGStreamer::getQuality

(

)

const

Gets the quality of the generated JPEG stream when writing.

Returns:

The quality of the JPEG stream.

IlBoolean IlvJPGStreamer::isProgressive

(

)

const

Gets whether the generated JPEG stream is progressive.

Returns:

IlTrue if the generated JPEG stream is progressive.

IlvBitmapData* IlvJPGStreamer::read

(

ILVSTDPREF istream &

stream

)

Reads a JPEG image from a stream.

Parameters:

stream

The stream to read from.

Returns:

An instance of IlvBitmapData.

void IlvJPGStreamer::setProgressive

(

IlBoolean

progressive

)

Sets whether the generated JPEG stream is progressive.

Parameters:

progressive

IlTrue if the stream is progressive.

void IlvJPGStreamer::setQuality

(

IlUInt

quality

)

Sets the quality of the generated JPEG stream.

This method sets the quality of the JPEG stream when writing. Useful values range from 10 (very low quality) to 100 (maximum quality).

Parameters:

quality

The quality of the JPEG stream.

IlBoolean IlvJPGStreamer::write	(	IlvBitmapData *	data,
		ILVSTDPREF ostream &	stream
	)

Writes an IlvBitmapDatato a JPEG stream.

Parameters:

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

Returns:

IlTrue if the bitmap data has been written.