CompressedImageWriter Class Reference

Writer for arbitrarily compressed images. More...

#include <fvutils/writers/compressed.h>

Inheritance diagram for CompressedImageWriter:

Inheritance graph
[legend]

List of all members.


Public Member Functions

 CompressedImageWriter (ImageCompressor *ic=NULL)
 Constructor.
virtual ~CompressedImageWriter ()
 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 ()
 Write to file.
virtual void set_image_compressor (ImageCompressor *ic)
 Set image compressor.

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 32 of file compressed.h.

Constructor & Destructor Documentation

CompressedImageWriter::CompressedImageWriter ( ImageCompressor *  ic = NULL  ) 

Constructor.

Parameters:
ic ImageCompressor to use for image compression

Definition at line 46 of file compressed.cpp.

References Writer::buffer, Writer::cspace, Writer::filename, Writer::height, and Writer::width.

CompressedImageWriter::~CompressedImageWriter (  )  [virtual]

Destructor.

Definition at line 58 of file compressed.cpp.

References Writer::filename.

Member Function Documentation

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

Set image buffer.

Parameters:
cspace color space of image
buffer buffer of image

Reimplemented from Writer.

Definition at line 88 of file compressed.cpp.

References ImageCompressor::set_image_buffer().

void CompressedImageWriter::set_dimensions ( unsigned int  width,
unsigned int  height 
) [virtual]

Set dimensions of image in pixels.

Parameters:
width width of image in pixels
height height of image in pixels.

Reimplemented from Writer.

Definition at line 77 of file compressed.cpp.

References ImageCompressor::set_image_dimensions().

void CompressedImageWriter::set_filename ( const char *  filename  )  [virtual]

Set filename.

Parameters:
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 from Writer.

Definition at line 65 of file compressed.cpp.

References ImageCompressor::set_filename().

void CompressedImageWriter::set_image_compressor ( ImageCompressor *  ic  )  [virtual]

Set image compressor.

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

Parameters:
ic new image compressor.

Definition at line 128 of file compressed.cpp.

References Writer::buffer, Writer::cspace, Writer::filename, Writer::height, ImageCompressor::set_filename(), ImageCompressor::set_image_buffer(), ImageCompressor::set_image_dimensions(), and Writer::width.

void CompressedImageWriter::write (  )  [virtual]

Write to file.

Implements Writer.

Definition at line 99 of file compressed.cpp.

References ImageCompressor::COMP_DEST_FILE, ImageCompressor::COMP_DEST_MEM, ImageCompressor::compress(), ImageCompressor::compressed_size(), Writer::filename, ImageCompressor::recommended_compressed_buffer_size(), ImageCompressor::set_compression_destination(), ImageCompressor::set_destination_buffer(), and ImageCompressor::supports_compression_destination().

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