Fawkes API  Fawkes Development Version
firevision::Writer Class Referenceabstract

#include <>>

Inheritance diagram for firevision::Writer:

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
 

Detailed Description

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.).

Author
Tim Niemueller

Definition at line 37 of file writer.h.

Constructor & Destructor Documentation

◆ Writer()

firevision::Writer::Writer ( const char *  extension = 0)

Constructor.

Parameters
extensionthe file extension

Definition at line 79 of file writer.cpp.

References extension.

◆ ~Writer()

firevision::Writer::~Writer ( )
virtual

Virtual empty destructor.

Definition at line 96 of file writer.cpp.

References filename.

Member Function Documentation

◆ set_buffer()

void firevision::Writer::set_buffer ( colorspace_t  cspace,
unsigned char *  buffer 
)
virtual

Set image buffer.

Parameters
cspacecolor space of image
bufferbuffer 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.

◆ set_dimensions()

void firevision::Writer::set_dimensions ( unsigned int  width,
unsigned int  height 
)
virtual

Set dimensions of image in pixels.

Parameters
widthwidth of image in pixels
heightheight of image in pixels.

Reimplemented in firevision::FvRawWriter, and firevision::CompressedImageWriter.

Definition at line 134 of file writer.cpp.

References buffer, and cspace.

◆ set_extension()

void firevision::Writer::set_extension ( const char *  extension)
protectedvirtual

Set the filename extension for file written by this writer.

Parameters
extensionthe extension

Definition at line 155 of file writer.cpp.

◆ set_filename()

void firevision::Writer::set_filename ( const char *  filename)
virtual

Set filename.

Parameters
filenamename 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().

◆ write()

void firevision::Writer::write ( )
pure virtual

Member Data Documentation

◆ basename

firevision::Writer::basename
protected

The basename of the file.

Definition at line 58 of file writer.h.

◆ buffer

◆ cspace

firevision::Writer::cspace
protected

◆ extension

firevision::Writer::extension
protected

The extension of the file.

Definition at line 59 of file writer.h.

Referenced by set_buffer(), and Writer().

◆ filename

◆ height

◆ width


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