PPL7-Icon Patrick's Programming Library Version 7.0.0 - Dokumentation
Aufstellung aller Elemente | Öffentliche Methoden
ppl7::grafix::ImageFilter Klassenreferenz
Grafik

Basisklasse für Import-/Export-Filter verschiedener Grafikformate. Mehr ...

Basisklasse für ppl7::grafix::ImageFilter_BMP, ppl7::grafix::ImageFilter_GIF, ppl7::grafix::ImageFilter_ImageMagick, ppl7::grafix::ImageFilter_JPEG, ppl7::grafix::ImageFilter_PNG, ppl7::grafix::ImageFilter_PPM, ppl7::grafix::ImageFilter_TGA und ppl7::grafix::ImageFilter_TIFF.

Öffentliche Methoden

 ImageFilter ()
 Konstruktor. Mehr ...
 
virtual ~ImageFilter ()
 Destruktor. Mehr ...
 
virtual String description ()
 
virtual int ident (FileObject &file, IMAGE &img)
 Grafikformat identifizieren. Mehr ...
 
virtual void load (FileObject &file, Drawable &surface, IMAGE &img)
 
virtual String name ()
 
 PPL7EXCEPTION (IllegalImageFormatException, Exception)
 
 PPL7EXCEPTION (EmptyImageException, Exception)
 
virtual void save (const Drawable &surface, FileObject &file, const Rect &area, const AssocArray &param=AssocArray())
 
virtual void save (const Drawable &surface, FileObject &file, const AssocArray &param=AssocArray())
 
void saveFile (const String &filename, const Drawable &surface, const Rect &area, const AssocArray &param=AssocArray())
 
void saveFile (const String &filename, const Drawable &surface, const AssocArray &param=AssocArray())
 

Ausführliche Beschreibung

Beschreibung:
Dies ist die Basisklasse für alle Import- und Export-Filter für verschiedene Grafikformate. eine von ImageFilter abgeleitete Klasse, die in der Lage ist ein bestimmtes Grafikformat zu lesen und optional auch zu schreiben. Eine Instanz des Filters muss mit "new" angelegt und mit der Funktion Grafix::addFilter in der Grafik-Engine registriert werden. Die Grafik-Engine kümmert sich bei Programmende selbst um das Löschen des Filters. Mit Grafix::unloadFilter kann ein Filter aber auch manuell von der Anwendung wieder entfernt werden. Mit Grafix::findFilter kann ein Filter anhand seines Namens gefunden werden.

Beschreibung der Konstruktoren und Destruktoren

ppl7::grafix::ImageFilter::ImageFilter ( )
Beschreibung:
Im Konstruktor werden interne Daten der Klasse initialisiert
ppl7::grafix::ImageFilter::~ImageFilter ( )
virtual
Beschreibung:
Der Destruktor sorgt dafür, dass durch die Klasse allokierter Speicher wieder freigegeben wird.

Dokumentation der Elementfunktionen

String ppl7::grafix::ImageFilter::description ( )
virtual

Erneute Implementation in ppl7::grafix::ImageFilter_TGA, ppl7::grafix::ImageFilter_PPM, ppl7::grafix::ImageFilter_GIF, ppl7::grafix::ImageFilter_ImageMagick, ppl7::grafix::ImageFilter_TIFF, ppl7::grafix::ImageFilter_BMP, ppl7::grafix::ImageFilter_JPEG und ppl7::grafix::ImageFilter_PNG.

int ppl7::grafix::ImageFilter::ident ( FileObject &  file,
IMAGE &  img 
)
virtual
Beschreibung:
Diese Funktion wird aufgerufen, um herauszufinden, ob ein Grafikformat durch diesen Filter gelesen werden kann. Ist dieser der Fall, muss die die Funktion 1 zurückgeben und die IMAGE-Struktur img füllen. Wird das Format nicht unterstützt, muss 0 zurückgegeben werden.
Parameter
[in]fileEine geöffnete Datei
[out]imgEine IMAGE-Struktur
Rückgabe
Wird das Grafikformat unterstützt, muss die Funktion 1 zurückgegen, andernfalls 0.

Erneute Implementation in ppl7::grafix::ImageFilter_TGA, ppl7::grafix::ImageFilter_PPM, ppl7::grafix::ImageFilter_GIF, ppl7::grafix::ImageFilter_ImageMagick, ppl7::grafix::ImageFilter_TIFF, ppl7::grafix::ImageFilter_BMP, ppl7::grafix::ImageFilter_JPEG und ppl7::grafix::ImageFilter_PNG.

void ppl7::grafix::ImageFilter::load ( FileObject &  file,
Drawable &  surface,
IMAGE &  img 
)
virtual

Erneute Implementation in ppl7::grafix::ImageFilter_TGA, ppl7::grafix::ImageFilter_PPM, ppl7::grafix::ImageFilter_GIF, ppl7::grafix::ImageFilter_ImageMagick, ppl7::grafix::ImageFilter_TIFF, ppl7::grafix::ImageFilter_BMP, ppl7::grafix::ImageFilter_JPEG und ppl7::grafix::ImageFilter_PNG.

String ppl7::grafix::ImageFilter::name ( )
virtual

Erneute Implementation in ppl7::grafix::ImageFilter_TGA, ppl7::grafix::ImageFilter_PPM, ppl7::grafix::ImageFilter_GIF, ppl7::grafix::ImageFilter_ImageMagick, ppl7::grafix::ImageFilter_TIFF, ppl7::grafix::ImageFilter_BMP, ppl7::grafix::ImageFilter_JPEG und ppl7::grafix::ImageFilter_PNG.

ppl7::grafix::ImageFilter::PPL7EXCEPTION ( IllegalImageFormatException  ,
Exception   
)
ppl7::grafix::ImageFilter::PPL7EXCEPTION ( EmptyImageException  ,
Exception   
)
void ppl7::grafix::ImageFilter::save ( const Drawable &  surface,
FileObject &  file,
const Rect &  area,
const AssocArray &  param = AssocArray() 
)
virtual
void ppl7::grafix::ImageFilter::save ( const Drawable &  surface,
FileObject &  file,
const AssocArray &  param = AssocArray() 
)
virtual

Erneute Implementation in ppl7::grafix::ImageFilter_TGA, ppl7::grafix::ImageFilter_PPM, ppl7::grafix::ImageFilter_GIF, ppl7::grafix::ImageFilter_ImageMagick, ppl7::grafix::ImageFilter_TIFF, ppl7::grafix::ImageFilter_BMP, ppl7::grafix::ImageFilter_JPEG und ppl7::grafix::ImageFilter_PNG.

void ppl7::grafix::ImageFilter::saveFile ( const String &  filename,
const Drawable &  surface,
const Rect &  area,
const AssocArray &  param = AssocArray() 
)
void ppl7::grafix::ImageFilter::saveFile ( const String &  filename,
const Drawable &  surface,
const AssocArray &  param = AssocArray() 
)
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien: