rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPPMStreamer Class Reference

Bitmap streamer class. More...

#include <ilviews/bitmaps/ppm.h>

Inheritance diagram for IlvPPMStreamer:
IlvBitmapStreamer

List of all members.

Public Member Functions

 IlvPPMStreamer ()
 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 isBinary () const
 Gets whether the generated PPM stream is written in binary mode.
IlvBitmapDataread (ILVSTDPREF istream &stream)
 Reads a PPM image from a stream.
void setBinary (IlBoolean interlace)
 Sets whether the generated PPM stream is written in binary mode.
IlBoolean write (IlvBitmapData *data, ILVSTDPREF ostream &stream)
 Writes an IlvBitmapData to a PPM stream.

Detailed Description

Bitmap streamer class.

Library: display

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

IlBoolean IlvPPMStreamer::canRead (  )  const [virtual]

Indicates that the instance can read from a stream.

Returns:
Always IlTrue.

Reimplemented from IlvBitmapStreamer.

IlBoolean IlvPPMStreamer::canWrite (  )  const [virtual]

Indicates that the instance can write to a stream.

Returns:
Always IlTrue.

Reimplemented from IlvBitmapStreamer.

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.

IlBoolean IlvPPMStreamer::isBinary (  )  const

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

Returns:
IlTrue if the generated PPM stream is binary.
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.
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.
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.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.