GFilter Class Reference

#include <GFilter.h>

Inheritance diagram for GFilter:

GDom GdcBmp

List of all members.

Public Member Functions

ProgressGetProgress ()
 Get the progress meter.
void SetProgress (Progress *Prg)
 Set the progress meter.
virtual int GetCapabilites ()
virtual int GetImages ()
virtual bool ReadImage (GSurface *Out, GStream *In)=0
virtual bool WriteImage (GStream *Out, GSurface *In)=0


Detailed Description

General base class for image filters. If you are creating a new filter you will need to also create a factory for it by inheriting another singleton class from GFilterFactory.

Member Function Documentation

virtual int GFilter::GetCapabilites (  )  [inline, virtual]

Override this to return the capabilities of your filter.

Returns:
some combination of FILTER_CAP_READ, FILTER_CAP_WRITE and FILTER_CAP_INFO.

Reimplemented in GdcBmp.

virtual int GFilter::GetImages (  )  [inline, virtual]

Returns:
the number of images in the file

virtual bool GFilter::ReadImage ( GSurface Out,
GStream In 
) [pure virtual]

Reads an image into the specified surface. Override to implement reading an image. Also you need to return FILTER_CAP_READ from GetCapabilites if implemented.

Implemented in GdcBmp.

virtual bool GFilter::WriteImage ( GStream Out,
GSurface In 
) [pure virtual]

Writes an image from the specified surface. Override to implement writing an image. Also you need to return FILTER_CAP_WRITE from GetCapabilites if implemented.

Implemented in GdcBmp.


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

Generated on Wed Dec 1 15:41:03 2010 for Lgi by  doxygen 1.5.7.1