claw::graphic::pcx Class Reference

A class for pcx pictures. More...

#include <pcx.hpp>

Inheritance diagram for claw::graphic::pcx:

Classes
class	header
	Header of a pcx file.
class	reader
	This class read data from a pcx file and store it in an image. More...
class	writer
	This class write an image in a pcx file. More...

Public Member Functions
	pcx (unsigned int w, unsigned int h)
	Constructor. Creates an empty image.
	pcx (const image &that)
	Copy constructor.
	pcx (std::istream &f)
	Constructor. Load an image from a pcx file.
void	save (std::ostream &os) const
	Save the content of the image in a stream.
Public Member Functions inherited from claw::graphic::image
	image ()
	Constructor. Creates an image without datas.
	image (unsigned int w, unsigned int h)
	Constructor. Creates an empty image.
	image (std::istream &f)
	Constructor. Reads an image from an input stream.
void	swap (image &that)
	Swap the content of two images.
unsigned int	width () const
	Gets image's width.
unsigned int	height () const
	Gets image's height.
scanline &	operator[] (unsigned int i)
	Gets a line of the image.
const scanline &	operator[] (unsigned int i) const
	Gets a line of the image.
iterator	begin ()
	Get an iterator pointing on the first pixel.
iterator	end ()
	Get an iterator pointing just past the last pixel.
const_iterator	begin () const
	Get an iterator pointing on the first pixel.
const_iterator	end () const
	Get an iterator pointing just past the last pixel.
void	merge (const image &that)
	Merge an image on the current image.
void	merge (const image &that, const math::coordinate_2d< int > &pos)
	Merge an image on the current image.
void	partial_copy (const image &that, const math::coordinate_2d< int > &pos)
	Copy an image on the current image.
void	flip ()
	Set the image upside down.
void	fill (const math::rectangle< int > r, const pixel_type &c)
	Fill an area of the image with a given color.
void	set_size (unsigned int w, unsigned int h)
	Set a new size to the image.
void	load (std::istream &f)
	Read the image from a stream.

Additional Inherited Members
Public Types inherited from claw::graphic::image
typedef rgba_pixel	pixel_type
	The type representing the colors of the pixels in the image.
typedef base_iterator< image, pixel_type >	iterator
	The type of the iterator on the pixels of the image.
typedef base_iterator< const image, const pixel_type >	const_iterator
	The type of the iterator to access constant pixels.

Detailed Description

A class for pcx pictures.

Author

Julien Jorge

Definition at line 49 of file pcx.hpp.

Constructor & Destructor Documentation

claw::graphic::pcx::pcx	(	unsigned int	w,
		unsigned int	h
	)

Constructor. Creates an empty image.

Parameters

w	Image's width.
h	Image's height.

Precondition

w > 0 and h > 0

Definition at line 39 of file pcx.cpp.

claw::graphic::pcx::pcx

(

const image &

that

)

Copy constructor.

Parameters

that	Image to copy from.

Definition at line 50 of file pcx.cpp.

claw::graphic::pcx::pcx

(

std::istream &

f

)

Constructor. Load an image from a pcx file.

Parameters

f

Pcx file.

Definition at line 61 of file pcx.cpp.

Member Function Documentation

void claw::graphic::pcx::save

(

std::ostream &

os

)

const

Save the content of the image in a stream.

Parameters

os	The stream in which we write.

Definition at line 71 of file pcx.cpp.

---

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

• pcx.hpp
• code/pcx.cpp