Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

GFilter Class Reference

#include <GFilter.h>

Inheritance diagram for GFilter:

GFile GStream GDom GdcBmp List of all members.

Public Member Functions

Progress * GetProgress ()
 Get the progress meter.
void SetProgress (Progress *Prg)
 Set the progress meter.
virtual int GetCapabilites ()
virtual int GetImages ()
 the number of images in the file
virtual bool ReadImage (GSurface *pDC)
virtual bool WriteImage (GSurface *pDC)

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 bool GFilter::ReadImage GSurface pDC  )  [inline, 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.

Reimplemented in GdcBmp.

virtual bool GFilter::WriteImage GSurface pDC  )  [inline, 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.

Reimplemented in GdcBmp.


The documentation for this class was generated from the following file:
Generated on Wed Oct 26 14:46:59 2005 for Lgi by  doxygen 1.4.1