Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvGIFStreamer Class Reference

Bitmap streamer class. More...

#include <ilviews/bitmaps/gif.h>

Inheritance diagram for IlvGIFStreamer:
IlvBitmapStreamer IlvValueInterface

Public Member Functions

 IlvGIFStreamer ()
 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 isGIF87Transparent () const
 Gets whether a GIF87 image is transparent by default. More...
 
IlvBitmapDataread (std::istream &stream)
 Reads a GIF image from a stream. More...
 
void setGIF87Transparent (IlBoolean transparent)
 Sets whether a GIF87 image is transparent by default. 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...
 
IlvQuantizergetQuantizer () const
 Returns the quantizer used by this streamer. More...
 
virtual IlvBitmapInformationreadInfo (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 IlvValuequeryValue (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 IlvBitmapStreamerGet (const char *name)
 Returns a streamer from its name. More...
 
static IlvBitmapStreamer ** GetRegisteredStreamers (IlUInt &count)
 Returns the registered streamers. More...
 
static IlvBitmapRead (IlvDisplay *display, std::istream &stream, const IlUChar *signature, IlUInt signatureLen)
 Reads a bitmap using the registered streamers. More...
 
static IlvBitmapDataReadBitmapData (std::istream &stream, const IlUChar *signature, IlUInt signatureLen)
 Reads bitmap data using the registered streamers. More...
 
static IlvBitmapInformationReadInfo (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: ilvgif

This streamer provides methods to deal with a stream containing a Compuserve GIF image.

This streamer can only read images, but is unable to save them.

Member Function Documentation

◆ canRead()

IlBoolean IlvGIFStreamer::canRead ( ) const
virtual

Indicates that the instance can read from a stream.

Returns
IlTrue.

Reimplemented from IlvBitmapStreamer.

◆ canWrite()

IlBoolean IlvGIFStreamer::canWrite ( ) const
virtual

Indicates that the instance can write to a stream.

Returns
IlFalse: there is no means to serialize an image using the GIF format with Rogue Wave Views.

Reimplemented from IlvBitmapStreamer.

◆ checkSignature()

IlBoolean IlvGIFStreamer::checkSignature ( const IlUChar data,
IlUInt  size 
)
virtual

Checks the signature of the input stream.

Parameters
dataThe data containing the signature of the stream.
sizeThe size of the data containing the signature.
Returns
IlTrue if the data contains a GIF signature.

Implements IlvBitmapStreamer.

◆ isGIF87Transparent()

IlBoolean IlvGIFStreamer::isGIF87Transparent ( ) const

Gets whether a GIF87 image is transparent by default.

Returns
IlTrue if the image is transparent.

◆ read()

IlvBitmapData* IlvGIFStreamer::read ( std::istream &  stream)
virtual

Reads a GIF image from a stream.

Parameters
streamThe stream to read from.
Returns
The bitmap data that was read.

Reimplemented from IlvBitmapStreamer.

◆ setGIF87Transparent()

void IlvGIFStreamer::setGIF87Transparent ( IlBoolean  transparent)

Sets whether a GIF87 image is transparent by default.

Parameters
transparentIlTrue if the image is transparent.