Public Member Functions | Static Public Member Functions

gnash::image::GifInput Class Reference

#include <GnashImageGif.h>

Inheritance diagram for gnash::image::GifInput:
Inheritance graph
[legend]
Collaboration diagram for gnash::image::GifInput:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 GifInput (boost::shared_ptr< IOChannel > in)
 Construct a GifInput object to read from an IOChannel.
 ~GifInput ()
void read ()
 Begin processing the image data.
size_t getHeight () const
 Get the image's height in pixels.
size_t getWidth () const
 Get the image's width in pixels.
size_t getComponents () const
 Get number of components (channels).
void readScanline (unsigned char *rgb_data)
 Read a scanline's worth of image data into the given buffer.

Static Public Member Functions

static DSOEXPORT std::auto_ptr
< Input
create (boost::shared_ptr< IOChannel > in)
 Create a GifInput and transfer ownership to the caller.

Constructor & Destructor Documentation

gnash::image::GifInput::GifInput ( boost::shared_ptr< IOChannel in  ) 

Construct a GifInput object to read from an IOChannel.

Parameters:
in The stream to read GIF data from. Ownership is shared between caller and GifInput, so it is freed automatically when the last owner is destroyed.

References data, and length.

Referenced by create().

gnash::image::GifInput::~GifInput (  ) 

Member Function Documentation

static DSOEXPORT std::auto_ptr<Input> gnash::image::GifInput::create ( boost::shared_ptr< IOChannel in  )  [inline, static]

Create a GifInput and transfer ownership to the caller.

Parameters:
in The IOChannel to read GIF data from.

References GifInput().

size_t gnash::image::GifInput::getComponents (  )  const [inline, virtual]

Get number of components (channels).

Returns:
The number of components, e.g. 3 for RGB

Implements gnash::image::Input.

size_t gnash::image::GifInput::getHeight (  )  const [virtual]

Get the image's height in pixels.

Returns:
The height of the image in pixels.

Implements gnash::image::Input.

size_t gnash::image::GifInput::getWidth (  )  const [virtual]

Get the image's width in pixels.

Returns:
The width of the image in pixels.

Implements gnash::image::Input.

void gnash::image::GifInput::read (  )  [virtual]

Begin processing the image data.

Implements gnash::image::Input.

void gnash::image::GifInput::readScanline ( unsigned char *  rgb_data  )  [virtual]

Read a scanline's worth of image data into the given buffer.

The amount of data read is getWidth() * getComponents().

Parameters:
rgbData The buffer for writing raw RGB data to.

Implements gnash::image::Input.


The documentation for this class was generated from the following files: