Fawkes API  Fawkes Development Version
firevision::CompressedImageWriter Class Reference

#include <>>

Inheritance diagram for firevision::CompressedImageWriter:

Public Member Functions

 CompressedImageWriter (ImageCompressor *ic=NULL)
 Constructor. More...
 
virtual ~CompressedImageWriter ()
 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 ()
 
virtual void set_image_compressor (ImageCompressor *ic)
 Set image compressor. More...
 
- Public Member Functions inherited from firevision::Writer
 Writer (const char *extension=0)
 Constructor. More...
 
virtual ~Writer ()
 Virtual empty destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from firevision::Writer
virtual void set_extension (const char *extension)
 Set the filename extension for file written by this writer. More...
 
- Protected Attributes inherited from firevision::Writer
char * filename
 
char * basename
 
char * extension
 
unsigned int width
 
unsigned int height
 
colorspace_t cspace
 
unsigned char * buffer
 

Detailed Description

Writer for arbitrarily compressed images. This class uses any image compressor to write compressed images to a file.

Author
Tim Niemueller

Definition at line 41 of file compressed.h.

Constructor & Destructor Documentation

◆ CompressedImageWriter()

firevision::CompressedImageWriter::CompressedImageWriter ( ImageCompressor ic = NULL)

Constructor.

Parameters
icImageCompressor to use for image compression

Definition at line 55 of file compressed.cpp.

◆ ~CompressedImageWriter()

firevision::CompressedImageWriter::~CompressedImageWriter ( )
virtual

Destructor.

Definition at line 66 of file compressed.cpp.

References firevision::Writer::filename, and firevision::ImageCompressor::set_filename().

Member Function Documentation

◆ set_buffer()

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

Set image buffer.

Parameters
cspacecolor space of image
bufferbuffer of image

Reimplemented from firevision::Writer.

Definition at line 93 of file compressed.cpp.

◆ set_dimensions()

void firevision::CompressedImageWriter::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 from firevision::Writer.

Definition at line 83 of file compressed.cpp.

◆ set_filename()

void firevision::CompressedImageWriter::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 from firevision::Writer.

Definition at line 72 of file compressed.cpp.

◆ set_image_compressor()

void firevision::CompressedImageWriter::set_image_compressor ( ImageCompressor ic)
virtual

Set image compressor.

Use this method to change the used image compressor at runtime.

Parameters
icnew image compressor.

Definition at line 133 of file compressed.cpp.

◆ write()

void firevision::CompressedImageWriter::write ( )
virtual

Write to file.

Implements firevision::Writer.

Definition at line 103 of file compressed.cpp.


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