Fawkes API
Fawkes Development Version
|
Interface to write images. More...
#include <>>
Public Member Functions | |
Writer (const char *extension=0) | |
Constructor. | |
virtual | ~Writer () |
Virtual empty destructor. | |
virtual void | set_filename (const char *filename) |
Set filename. | |
virtual void | set_dimensions (unsigned int width, unsigned int height) |
Set dimensions of image in pixels. | |
virtual void | set_buffer (colorspace_t cspace, unsigned char *buffer) |
Set image buffer. | |
virtual void | write ()=0 |
Write to file. | |
Protected Member Functions | |
virtual void | set_extension (const char *extension) |
Set the filename extension for file written by this writer. | |
Protected Attributes | |
char * | filename |
The complete filename. | |
char * | basename |
The basename of the file. | |
char * | extension |
The extension of the file. | |
unsigned int | width |
The width of the image. | |
unsigned int | height |
The height of the image. | |
colorspace_t | cspace |
The colorspace of the image. | |
unsigned char * | buffer |
The image-buffer. |
Interface to write images.
The writer interface defines the general API for image writers. These writers are used to write images to files on your harddrive (like JPEGs, PNGs etc.).
firevision::Writer::Writer | ( | const char * | extension = 0 | ) |
firevision::Writer::~Writer | ( | ) | [virtual] |
Virtual empty destructor.
Definition at line 94 of file writer.cpp.
void firevision::Writer::set_buffer | ( | colorspace_t | cspace, |
unsigned char * | buffer | ||
) | [virtual] |
Set image buffer.
cspace | color space of image |
buffer | buffer of image |
Reimplemented in firevision::PNMWriter, firevision::FvRawWriter, firevision::CompressedImageWriter, firevision::JpegWriter, and firevision::PNGWriter.
Definition at line 143 of file writer.cpp.
void firevision::Writer::set_dimensions | ( | unsigned int | width, |
unsigned int | height | ||
) | [virtual] |
Set dimensions of image in pixels.
width | width of image in pixels |
height | height of image in pixels. |
Reimplemented in firevision::FvRawWriter, and firevision::CompressedImageWriter.
Definition at line 132 of file writer.cpp.
Referenced by firevision::SEGenerator::linear().
void firevision::Writer::set_extension | ( | const char * | extension | ) | [protected, virtual] |
Set the filename extension for file written by this writer.
extension | the extension |
Definition at line 153 of file writer.cpp.
void firevision::Writer::set_filename | ( | const char * | filename | ) | [virtual] |
Set filename.
filename | name of file to write to. This can either be the complete filename (including) extension or the basename only in which case the extension is added. |
Reimplemented in firevision::CompressedImageWriter.
Definition at line 106 of file writer.cpp.
Referenced by firevision::SEGenerator::linear(), firevision::FvRawWriter::FvRawWriter(), firevision::JpegWriter::JpegWriter(), firevision::PNGWriter::PNGWriter(), and firevision::PNMWriter::PNMWriter().
void firevision::Writer::write | ( | ) | [pure virtual] |
Write to file.
Implemented in firevision::PNMWriter, firevision::FvRawWriter, firevision::CompressedImageWriter, firevision::JpegWriter, and firevision::PNGWriter.
firevision::Writer::basename [protected] |
firevision::Writer::buffer [protected] |
The image-buffer.
Definition at line 57 of file writer.h.
Referenced by firevision::JpegWriter::JpegWriter(), firevision::JpegWriter::set_buffer(), firevision::JpegWriter::write(), firevision::PNGWriter::set_buffer(), and firevision::PNGWriter::write().
firevision::Writer::cspace [protected] |
The colorspace of the image.
Definition at line 55 of file writer.h.
Referenced by firevision::FvRawWriter::set_buffer().
firevision::Writer::extension [protected] |
firevision::Writer::filename [protected] |
The complete filename.
Definition at line 48 of file writer.h.
Referenced by firevision::FvRawWriter::write(), firevision::JpegWriter::write(), firevision::PNGWriter::write(), and firevision::PNMWriter::write().
firevision::Writer::height [protected] |
The height of the image.
Definition at line 53 of file writer.h.
Referenced by firevision::FvRawWriter::FvRawWriter(), firevision::FvRawWriter::set_dimensions(), firevision::JpegWriter::write(), firevision::PNGWriter::PNGWriter(), and firevision::PNGWriter::write().
firevision::Writer::width [protected] |
The width of the image.
Definition at line 52 of file writer.h.
Referenced by firevision::FvRawWriter::FvRawWriter(), firevision::FvRawWriter::set_dimensions(), firevision::JpegWriter::write(), firevision::PNGWriter::PNGWriter(), and firevision::PNGWriter::write().