WXP::PngFile Class Reference

This class reads and write PNG image files. More...

#include "../include/PngFile.h"

Public Member Functions
	PngFile ()
	~PngFile ()
int	init ()
	PngFile (const char *filename, int access)
int	open (const char *filename, int access)
bool	isOpen ()
int	close ()
int	setInterlace (int val)
int	setTitle (const char *str)
int	setComment (const char *str)
int	read (Image &image)
int	read (const char *filename, Image &image)
int	write (Image &image)
int	write (const char *filename, Image &image)

Detailed Description

This class reads and write PNG image files.

Author

Dan Vietor

Constructor & Destructor Documentation

PngFile() [1/2]

PngFile::PngFile

(

)

Constructor

References init().

~PngFile()

PngFile::~PngFile

(

)

Destructor

PngFile() [2/2]

PngFile::PngFile	(	const char *	filename,
		int	raccess )

Constructor. Opens the file

Parameters

filename	PNG filename
raccess	Access (FileAttr:READ, FileAttr::WRITE)

References init(), and open().

Member Function Documentation

close()

int PngFile::close

(

)

Closes the file

Referenced by read().

init()

int PngFile::init

(

)

Initializes the class

Referenced by PngFile(), and PngFile().

isOpen()

bool PngFile::isOpen

(

)

Returns true if file open

open()

int PngFile::open	(	const char *	filename,
		int	raccess )

Opens the file

Parameters

filename	PNG filename
raccess	Access (FileAttr:READ, FileAttr::WRITE)

References WXP::FileAttr::READ, and WXP::FileAttr::WRITE.

Referenced by PngFile(), read(), and write().

read() [1/2]

int PngFile::read	(	const char *	filename,
		Image &	image )

Reads in an image from file

Parameters

filename

The image filename

Return values

image

The output image

References open(), WXP::FileAttr::READ, and read().

read() [2/2]

int PngFile::read

(

Image &

image

)

Reads the image from an open file

Return values

image

The output image

References WXP::Image::allocColors(), WXP::Image::allocData(), close(), WXP::DateTool::decode(), WXP::DomainTool::decode(), WXP::Strings::equal(), WXP::StrLib::equal(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Wxp::outDebug(), WXP::Image::setBlu(), WXP::Image::setGrn(), WXP::Image::setPixel(), and WXP::Image::setRed().

Referenced by read().

setComment()

int PngFile::setComment

(

const char *

str

)

Sets a comment to be saved with image

Parameters

str

Comment

References WXP::StrLib::copy().

setInterlace()

int PngFile::setInterlace

(

int

val

)

Set up interlacing (not used)

Parameters

val	Interlace type

setTitle()

int PngFile::setTitle

(

const char *

str

)

Sets a title to be attached to the image file

Parameters

str	Image title

References WXP::StrLib::copy().

write() [1/2]

int PngFile::write	(	const char *	filename,
		Image &	image )

Writes an image to a file.

Parameters

filename	The output filename
image	Image to write

References open(), WXP::FileAttr::WRITE, and write().

write() [2/2]

int PngFile::write

(

Image &

image

)

Writes an image to an open file. In addition, the info label, date/time and domain information will be saved in a text string in the file.

Parameters

image

Image to write

References WXP::StrLib::acopy(), WXP::StrLib::copy(), WXP::DateTool::getCurrent(), WXP::Image::getPixel(), WXP::Image::getRow(), WXP::Const::MISS, WXP::Wxp::outDebug(), WXP::ImageMath::toIndex(), WXP::Domain::toString(), and WXP::StrLib::valid().

Referenced by write().

---

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

• PngFile.h
• PngFile.cc