IlvPPMStreamer Class Reference

Bitmap streamer class. More...

#include <ilviews/bitmaps/ppm.h>

Inheritance diagram for IlvPPMStreamer:

Public Member Functions
	IlvPPMStreamer ()
	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	isBinary () const
	Gets whether the generated PPM stream is written in binary mode. More...
IlvBitmapData *	read (ILVSTDPREF istream &stream)
	Reads a PPM image from a stream. More...
void	setBinary (IlBoolean interlace)
	Sets whether the generated PPM stream is written in binary mode. More...
IlBoolean	write (IlvBitmapData *data, ILVSTDPREF ostream &stream)
	Writes an IlvBitmapData to a PPM 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 (std::istream &stream)
	Reads from a stream. More...
virtual IlvBitmapInformation *	readInfo (std::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 rpCallback, IlAny arg=0)
	Sets the callback for read progression. More...
virtual void	setWriteProgressCallback (IlvProgressCallback wpCallback, IlAny arg=0)
	Sets the callback for write progression. More...
virtual IlBoolean	write (IlvBitmapData *bitmapData, std::ostream &stream)
	Writes an IlvBitmapData to a stream. More...
Public Member Functions inherited from IlvValueInterface
virtual IlBoolean	applyValue (const IlvValue &value)
	Apply an accessor. More...
virtual IlBoolean	changeValue (const IlvValue &val)
	Changes the value of an accessor. More...
virtual IlBoolean	changeValues (const IlvValue *values, IlUShort count=0)
	Changes several accessor values simultaneously. More...
virtual void	getAccessors (const IlSymbol *const **names, const IlvValueTypeClass *const **types, IlUInt &count) const
	Retrieves the list of available accessors of an object. More...
virtual IlvValue &	queryValue (IlvValue &val) const
	Retrieves an accessor value. More...
virtual void	queryValues (IlvValue *values, IlUShort count) const
	Retrieves multiple accessor values simultaneously. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvBitmapStreamer
static IlvBitmapStreamer *	Get (const char *name)
	Returns a streamer from its name. More...
static IlvBitmapStreamer **	GetRegisteredStreamers (IlUInt &count)
	Returns the registered streamers. More...
static IlvBitmap *	Read (IlvDisplay *display, std::istream &stream, const IlUChar *signature, IlUInt signatureLen)
	Reads a bitmap using the registered streamers. More...
static IlvBitmapData *	ReadBitmapData (std::istream &stream, const IlUChar *signature, IlUInt signatureLen)
	Reads bitmap data using the registered streamers. More...
static IlvBitmapInformation *	ReadInfo (std::istream &stream, const IlUChar *signature, IlUInt signatureLen)
	Reads bitmap information using the registered streamers. More...
static void	Register (IlvBitmapStreamer *streamer)
	Registers the given streamer. More...
static IlBoolean	UnRegister (IlvBitmapStreamer *streamer)
	Unregisters the given streamer. More...

Detailed Description

Bitmap streamer class.

Library: ilvppm

This streamer provides methods to deal with a stream containing a PPM image.
This streamer can read and write.
When reading or writing, callbacks will be called at each scanline. The data is written in binary mode.

Member Function Documentation

canRead()

IlBoolean IlvPPMStreamer::canRead ( ) const

virtual

Indicates that the instance can read from a stream.

Returns

Always IlTrue.

Reimplemented from IlvBitmapStreamer.

canWrite()

IlBoolean IlvPPMStreamer::canWrite ( ) const

virtual

Indicates that the instance can write to a stream.

Returns

Always IlTrue.

Reimplemented from IlvBitmapStreamer.

checkSignature()

IlBoolean IlvPPMStreamer::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 PPM signature.

Implements IlvBitmapStreamer.

isBinary()

IlBoolean IlvPPMStreamer::isBinary

(

)

const

Gets whether the generated PPM stream is written in binary mode.

Returns

IlTrue if the generated PPM stream is binary.

read()

IlvBitmapData* IlvPPMStreamer::read

(

ILVSTDPREF istream &

stream

)

Reads a PPM image from a stream.

Parameters

stream

The stream to read from.

Returns

An instance of IlvBitmapData.

setBinary()

void IlvPPMStreamer::setBinary

(

IlBoolean

interlace

)

Sets whether the generated PPM stream is written in binary mode.

Parameters

interlace

IlTrue if the stream is in binary mode.

write()

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

Writes an IlvBitmapData to a PPM stream.

Parameters

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

Returns

IlTrue if the bitmap data has been written.