cvr::ioPNG::ioPNG::parameters Class Reference

Parameter class of the ioBMP class. More...

#include <cvrIOPNG.h>

Inheritance diagram for cvr::ioPNG::ioPNG::parameters:

[legend]

Collaboration diagram for cvr::ioPNG::ioPNG::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
int	bitsPerPixel
bool	useAlphaChannel

---

Detailed Description

Parameter class of the ioBMP class.

---

Constructor & Destructor Documentation

cvr::ioPNG::ioPNG::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

cvr::ioPNG::ioPNG::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

---

Member Function Documentation

virtual parameters* cvr::ioPNG::ioPNG::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::ioImageInterface::ioImageInterface::parameters.

parameters& cvr::ioPNG::ioPNG::parameters::copy

(

const parameters &

other

)

Copy member.

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

virtual const std::string& cvr::ioPNG::ioPNG::parameters::name

(

)

const [virtual]

Returns the name of this class.

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

virtual parameters* cvr::ioPNG::ioPNG::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Implements cvr::ioImageInterface::ioImageInterface::parameters.

parameters& cvr::ioPNG::ioPNG::parameters::operator=

(

const parameters &

other

)

Copy operator.

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

virtual bool cvr::ioPNG::ioPNG::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

Write the parameters in the given ioHandler.

Parameters:

	handler	The ioHandler to be used
	complete	If true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

virtual bool cvr::ioPNG::ioPNG::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

Write the parameters in the given ioHandler.

Parameters:

	handler	The ioHandler to be used
	complete	If true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

---

Member Data Documentation

int cvr::ioPNG::ioPNG::parameters::bitsPerPixel

Bits per pixel.

Default value: 24

bool cvr::ioPNG::ioPNG::parameters::useAlphaChannel

True if alpha channel is to be considered.

If this is true, bitsPerPixel must be 32!

Default value: false

---

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

• cvrIOPNG.h