Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Bitmap streamer class. More...
#include <ilviews/bitmaps/tiff.h>
Public Member Functions | |
IlvTIFFStreamer () | |
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) |
Indicates whether the instance can handle the stream. More... | |
virtual void | closeStream (IlAny identifier) |
Closes a stream. More... | |
Compression | getCompression () const |
Returns the compression mode. More... | |
IlUInt | getRowsPerStrip () const |
Returns The number of rows per strip used when saving. More... | |
IlBoolean | getTagValue (IlAny identifier, IlUInt tag, IlUInt &count, IlAny value=0) |
Returns the value of a given tag in a stream. More... | |
IlUInt | getTileHeight () const |
Returns The tile height used when saving. More... | |
IlUInt | getTileWidth () const |
Returns the tile width used when saving. More... | |
Mode | getWriteMode () const |
Returns the write mode. More... | |
virtual IlAny | openStream (ILVSTDPREF istream &stream) |
Opens the stream. More... | |
IlvBitmapData * | read (ILVSTDPREF istream &stream) |
Reads a TIFF image from a stream. More... | |
IlvBitmapInformation * | readInfo (ILVSTDPREF istream &stream) |
Reads image information from a stream. More... | |
IlvBitmapData * | readTile (ILVSTDPREF istream &stream, IlUShort x, IlUShort y) |
Reads a TIFF tile from a stream. More... | |
void | setCompression (Compression compression) |
Sets the compression mode used when writing. More... | |
void | setRowsPerStrip (IlUInt rowsperstrip) |
Sets the number of rows per strip used when saving. More... | |
void | setTileHeight (IlUInt tileheight) |
Sets the tile height used when saving. More... | |
void | setTileWidth (IlUInt tilewidth) |
Sets the tile width used when saving. More... | |
void | setWriteMode (Mode mode) |
Sets the write mode. More... | |
IlBoolean | write (IlvBitmapData *data, ILVSTDPREF ostream &stream) |
Writes an IlvBitmapData to a TIFF stream. More... | |
virtual void | writeCustomData (IlAny identifier) |
Allows custom data to be written in the stream. More... | |
IlBoolean | writeTagValue (IlAny identifier, IlUInt tag, IlUInt count, IlAny value=0) |
Writes a tag in the 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... | |
Bitmap streamer class.
Library: xviews or winviews or mviews (mutually exclusive)
This streamer provides methods to deal with a stream containing a TIFF image. This streamer can read and write.
|
virtual |
Indicates that the instance can read from a stream.
IlTrue
. Reimplemented from IlvBitmapStreamer.
|
virtual |
Indicates that the instance can write to a stream.
IlTrue
. Reimplemented from IlvBitmapStreamer.
Indicates whether the instance can handle the stream.
data | The stream signature. |
size | The size of the stream signature. |
IlTrue
if the instance recognizes the signature. Implements IlvBitmapStreamer.
|
virtual |
Closes a stream.
identifier | The stream identifier. |
Compression IlvTIFFStreamer::getCompression | ( | ) | const |
Returns the compression mode.
IlUInt IlvTIFFStreamer::getRowsPerStrip | ( | ) | const |
Returns The number of rows per strip used when saving.
IlBoolean IlvTIFFStreamer::getTagValue | ( | IlAny | identifier, |
IlUInt | tag, | ||
IlUInt & | count, | ||
IlAny | value = 0 |
||
) |
Returns the value of a given tag in a stream.
This method must be called between openStream
and closeStream
. The tag value must be known by the underlying TIFF library. Values must be copied.
identifier | The stream identifier. |
tag | The tag |
count | The number of elements. |
value | The tag value. |
IlTrue
if the tag is known and its value has been found. IlUInt IlvTIFFStreamer::getTileHeight | ( | ) | const |
Returns The tile height used when saving.
IlUInt IlvTIFFStreamer::getTileWidth | ( | ) | const |
Returns the tile width used when saving.
Mode IlvTIFFStreamer::getWriteMode | ( | ) | const |
Returns the write mode.
|
virtual |
Opens the stream.
stream | The stream to open. |
IlvBitmapData* IlvTIFFStreamer::read | ( | ILVSTDPREF istream & | stream | ) |
Reads a TIFF image from a stream.
stream | The stream to read from. |
IlvBitmapData
. IlvBitmapInformation* IlvTIFFStreamer::readInfo | ( | ILVSTDPREF istream & | stream | ) |
Reads image information from a stream.
stream | The stream to read from. |
IlvBitmapInformation
. IlvBitmapData* IlvTIFFStreamer::readTile | ( | ILVSTDPREF istream & | stream, |
IlUShort | x, | ||
IlUShort | y | ||
) |
Reads a TIFF tile from a stream.
stream | The stream to read from. |
x | The horizontal position of the tile. |
y | The vertical position of the tile. |
IlvBitmapData
. void IlvTIFFStreamer::setCompression | ( | Compression | compression | ) |
Sets the compression mode used when writing.
The compression can be one of IlvTIFFstreamer::None
, IlvTIFFstreamer::Packbits
, or IlvTIFFstreamer::Zip
.
compression | The new compression mode. |
void IlvTIFFStreamer::setRowsPerStrip | ( | IlUInt | rowsperstrip | ) |
Sets the number of rows per strip used when saving.
rowsperstrip | The new rows per strip value. |
void IlvTIFFStreamer::setTileHeight | ( | IlUInt | tileheight | ) |
Sets the tile height used when saving.
tileheight | The new tile height. |
void IlvTIFFStreamer::setTileWidth | ( | IlUInt | tilewidth | ) |
Sets the tile width used when saving.
tilewidth | The new tile width. |
void IlvTIFFStreamer::setWriteMode | ( | Mode | mode | ) |
Sets the write mode.
The mode can be either IlvTIFFStreamer::Tile
or IlvTIFFStreamer::Strip
.
mode | The new write mode. |
IlBoolean IlvTIFFStreamer::write | ( | IlvBitmapData * | data, |
ILVSTDPREF ostream & | stream | ||
) |
Writes an IlvBitmapData
to a TIFF stream.
data | The bitmap data to write. |
stream | The stream to write to. |
IlTrue
if the bitmap data has been written.
|
virtual |
Allows custom data to be written in the stream.
This method will be called by the write
method.
identifier | The stream identifier. |
IlBoolean IlvTIFFStreamer::writeTagValue | ( | IlAny | identifier, |
IlUInt | tag, | ||
IlUInt | count, | ||
IlAny | value = 0 |
||
) |
Writes a tag in the stream.
identifier | The stream identifier. |
tag | The tag |
count | the number of elements. |
value | The tag value. |
IlTrue
if the tag is known and its value has been written. © Copyright 2016, 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.