rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvRGBStreamer Class Reference

Bitmap streamer class. More...

#include <ilviews/bitmaps/rgb.h>

Inheritance diagram for IlvRGBStreamer:
IlvBitmapStreamer

List of all members.

Public Member Functions

 IlvRGBStreamer ()
 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 getAlphaLevel () const
 Gets the alpha level of the RGB streamer.
IlvBitmapDataread (istream &stream)
 Reads an RGB image from a stream.
void setAlphaLevel (IlUInt level)
 Sets the alpha level for the RGB stream.
IlBoolean write (IlvBitmapData *data, ostream &stream)
 Writes an IlvBitmapData to a stream.

Detailed Description

Bitmap streamer class.

Library: display

This streamer provides methods to deal with a stream containing an RGB image. It supports reading from all RGB streams. This streamer can only read.
When reading images, callbacks will be called at each scanline.


Member Function Documentation

IlBoolean IlvRGBStreamer::canRead (  )  const [virtual]

Indicates that the instance can read from a stream.

Returns:
IlTrue.

Reimplemented from IlvBitmapStreamer.

IlBoolean IlvRGBStreamer::canWrite (  )  const [virtual]

Indicates that the instance can write to a stream.

Returns:
IlTrue.

Reimplemented from IlvBitmapStreamer.

IlBoolean IlvRGBStreamer::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 an RGB signature.

Implements IlvBitmapStreamer.

IlUInt IlvRGBStreamer::getAlphaLevel (  )  const

Gets the alpha level of the RGB streamer.

Returns:
The alpha level.
IlvBitmapData* IlvRGBStreamer::read ( istream &  stream  )  [virtual]

Reads an RGB image from a stream.

Parameters:
stream The stream to read from.
Returns:
An instance of IlvBitmapData.

Reimplemented from IlvBitmapStreamer.

void IlvRGBStreamer::setAlphaLevel ( IlUInt  level  ) 

Sets the alpha level for the RGB stream.

Alpha levels greater than the given argument are converted to a fully opaque value while alpha levels smaller than the given argument are converted to a fully transparent value.

Parameters:
level The alpha level.
IlBoolean IlvRGBStreamer::write ( IlvBitmapData bitmapData,
ostream &  stream 
) [virtual]

Writes an IlvBitmapData to a stream.

Parameters:
bitmapData The bitmap data to write.
stream The stream to write to.
Returns:
IlTrue if the bitmap data has been written.

Reimplemented from IlvBitmapStreamer.


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