Fawkes API
Fawkes Development Version
|
#include <>>
Public Member Functions | |
Writer (const char *extension=0) | |
Constructor. More... | |
virtual | ~Writer () |
Virtual empty destructor. More... | |
virtual void | set_filename (const char *filename) |
Set filename. More... | |
virtual void | set_dimensions (unsigned int width, unsigned int height) |
Set dimensions of image in pixels. More... | |
virtual void | set_buffer (colorspace_t cspace, unsigned char *buffer) |
Set image buffer. More... | |
virtual void | write ()=0 |
Protected Member Functions | |
virtual void | set_extension (const char *extension) |
Set the filename extension for file written by this writer. More... | |
Protected Attributes | |
char * | filename |
char * | basename |
char * | extension |
unsigned int | width |
unsigned int | height |
colorspace_t | cspace |
unsigned char * | 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 | ) |
Constructor.
extension | the file extension |
Definition at line 79 of file writer.cpp.
References extension.
|
virtual |
|
virtual |
Set image buffer.
cspace | color space of image |
buffer | buffer of image |
Reimplemented in firevision::PNMWriter, firevision::FvRawWriter, firevision::PNGWriter, firevision::JpegWriter, and firevision::CompressedImageWriter.
Definition at line 145 of file writer.cpp.
References extension.
|
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 134 of file writer.cpp.
|
protectedvirtual |
Set the filename extension for file written by this writer.
extension | the extension |
Definition at line 155 of file writer.cpp.
|
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 108 of file writer.cpp.
Referenced by firevision::FvRawWriter::FvRawWriter(), firevision::JpegWriter::JpegWriter(), firevision::PNGWriter::PNGWriter(), and firevision::PNMWriter::PNMWriter().
|
pure virtual |
Write to file.
Implemented in firevision::PNMWriter, firevision::FvRawWriter, firevision::PNGWriter, firevision::JpegWriter, and firevision::CompressedImageWriter.
|
protected |
|
protected |
The image-buffer.
Definition at line 66 of file writer.h.
Referenced by firevision::JpegWriter::JpegWriter(), firevision::JpegWriter::set_buffer(), firevision::PNGWriter::set_buffer(), set_dimensions(), firevision::JpegWriter::write(), and firevision::PNGWriter::write().
|
protected |
The colorspace of the image.
Definition at line 64 of file writer.h.
Referenced by firevision::JpegWriter::set_buffer(), firevision::PNGWriter::set_buffer(), firevision::FvRawWriter::set_buffer(), firevision::PNMWriter::set_buffer(), and set_dimensions().
|
protected |
The extension of the file.
Definition at line 59 of file writer.h.
Referenced by set_buffer(), and Writer().
|
protected |
The complete filename.
Definition at line 57 of file writer.h.
Referenced by firevision::FvRawWriter::FvRawWriter(), firevision::JpegWriter::JpegWriter(), firevision::PNGWriter::PNGWriter(), firevision::PNMWriter::PNMWriter(), firevision::JpegWriter::write(), firevision::PNGWriter::write(), firevision::FvRawWriter::write(), firevision::PNMWriter::write(), firevision::CompressedImageWriter::~CompressedImageWriter(), and ~Writer().
|
protected |
The height of the image.
Definition at line 62 of file writer.h.
Referenced by firevision::FvRawWriter::FvRawWriter(), firevision::PNGWriter::PNGWriter(), firevision::FvRawWriter::set_dimensions(), firevision::JpegWriter::write(), and firevision::PNGWriter::write().
|
protected |
The width of the image.
Definition at line 61 of file writer.h.
Referenced by firevision::FvRawWriter::FvRawWriter(), firevision::PNGWriter::PNGWriter(), firevision::FvRawWriter::set_dimensions(), firevision::JpegWriter::write(), and firevision::PNGWriter::write().