version 3.3

VRS::CompressedImageWriter Class Reference

#include <vrs/io/compressedimagewriter.h>

Inheritance diagram for VRS::CompressedImageWriter:

VRS::ObjectWriter VRS::SharedObj VRS::Visitable

List of all members.

Public Member Functions

 CompressedImageWriter (CompressedImage::Compression compression=CompressedImage::R4G4B4A4)
virtual bool canHandle (SharedObj *obj) const
virtual void write (SharedObj *obj, const std::string &filename) const
virtual const char * objectFormatName () const
virtual const char * objectFileSuffix () const
 Format name is "Compressed Image", and suffix is "cprs".
 VRS_TYPEINFO (CompressedImageWriter, ObjectWriter)

Static Public Member Functions

static void writeFile (Image *image, const std::string &filename, CompressedImage::Compression compression=CompressedImage::R4G4B4A4)
 Write the image as compressed-image file.


Constructor & Destructor Documentation

VRS::CompressedImageWriter::CompressedImageWriter ( CompressedImage::Compression  compression = CompressedImage::R4G4B4A4  ) 

"compression" include CompressedImage::S3TC, CompressedImage::R3G3B2, CompressedImage::R5G6B5, CompressedImage::R5G5B5A1, CompressedImage::R4G4B4A4. See the CompressedImage class for further details about the compression type.


Member Function Documentation

virtual bool VRS::CompressedImageWriter::canHandle ( SharedObj obj  )  const [virtual]

Implements VRS::ObjectWriter.

virtual void VRS::CompressedImageWriter::write ( SharedObj obj,
const std::string &  filename 
) const [virtual]

This writer can handle any type of images with 1 or 3 layers; images other than compressed images are converted into a temporary compressed image. Note: Uncompressed images must have a size equal to a power of 2. Use 'copyPow2' method to scale arbitrary images to that size.

Implements VRS::ObjectWriter.

virtual const char* VRS::CompressedImageWriter::objectFormatName (  )  const [virtual]

Implements VRS::ObjectWriter.

virtual const char* VRS::CompressedImageWriter::objectFileSuffix (  )  const [virtual]

Format name is "Compressed Image", and suffix is "cprs".

Implements VRS::ObjectWriter.

static void VRS::CompressedImageWriter::writeFile ( Image image,
const std::string &  filename,
CompressedImage::Compression  compression = CompressedImage::R4G4B4A4 
) [static]

Write the image as compressed-image file.

VRS::CompressedImageWriter::VRS_TYPEINFO ( CompressedImageWriter  ,
ObjectWriter   
)


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

Generated on Mon May 21 06:00:18 2012 by Doxygen 1.5.6
© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact