PPMIO Class Reference

An ImageIO plugin supporting reading and writing of RGB PPM images. More...

#include <imageio/PPMIO.h>

Inheritance diagram for PPMIO:

[legend]List of all members.

Public Member Functions
bool	readImage (const char *filename, Image *&result)
bool	writeImage (const char *filename, const Image *image)
bool	supportsExtension (const char *extension)
void	registerExtensions (DynArray< std::string > &extensions)

---

Detailed Description

An ImageIO plugin supporting reading and writing of RGB PPM images.

---

Member Function Documentation

bool PPMIO::readImage (  const char *  filename, Image *&  result )  [inline, virtual]

Given an Image and a filename, try to create an Image. The system will guarantee that the extension is supported by this plugin. Parameters: [in]  filename  The name of the file to read from. [out]  result  The resulting Image. Memory has to be allocated. Returns: readImage returns true if everything went smoothly. Implements ImageIO.

bool PPMIO::writeImage (  const char *  filename, const Image *  image )  [inline, virtual]

Given an Image and a filename, try to write the Image to disk. The system will guarantee that the extension is supported by this plugin. Parameters: [in]  filename  The name of the file to write to. [in]  image  The Image data to write out. Returns: writeImage returns true if everything went smoothly. Implements ImageIO.

bool PPMIO::supportsExtension (  const char *  extension  )  [inline, virtual]

Determine if this plugin supports the given extension. Parameters: [in]  extension  A lowercase string extension (e.g. "tif") Returns: True if the plugin supports this extension, false otherwise. Implements ImageIO.

void PPMIO::registerExtensions (  DynArray< std::string > &  extensions  )  [inline, virtual]

Build a list of all the extensions this plugin can support Parameters: [out]  extensions  A DynArray to hold the list of extensions. Returns: The return is by reference (extensions parameter). Implements ImageIO.

---

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

• PPMIO.h

---