image_format_jpeg Class Reference

#include <jpeg.h>

Inheritance diagram for image_format_jpeg:

List of all members.

Public Member Functions
virtual	~image_format_jpeg ()
Static Public Member Functions
static pointer	create (const std::string &filename)
static pointer	create_blank (int width, int height)
Protected Member Functions
const char *	type_name () const
void	save_to_file (const std::string &filename) const
Private Member Functions
	image_format_jpeg ()
	image_format_jpeg (int width, int height, data_t *data)
	image_format_jpeg (int width, int height)
	image_format_jpeg (const image_format_jpeg &)
image_format_jpeg &	operator= (const image_format_jpeg &)

---

Detailed Description

The image_format_jpeg class is used to represent an image in JPEG format.

Definition at line 28 of file jpeg.h.

---

Constructor & Destructor Documentation

image_format_jpeg::~image_format_jpeg

(

)

[virtual]

The destructor.

Definition at line 27 of file jpeg.cc.

image_format_jpeg::image_format_jpeg

(

)

[private]

The default constructor. Do not use.

image_format_jpeg::image_format_jpeg	(	int	width,
		int	height,
		data_t *	data
	)		[private]

The constructor. It is private on purpose, use the "create" class method instead.

Parameters:

width	The width of the new image
height	The height of the new image
data	The data of the new image, indexed row then column then component (RGBA).

Definition at line 38 of file jpeg.cc.

image_format_jpeg::image_format_jpeg	(	int	width,
		int	height
	)		[private]

The constructor. It is private on purpose, use the "create_blank" class method instead.

Parameters:

width	The width of the new image
height	The height of the new image

Definition at line 32 of file jpeg.cc.

image_format_jpeg::image_format_jpeg

(

const image_format_jpeg &

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

image::pointer image_format_jpeg::create

(

const std::string &

filename

)

[static]

The create class method is used to create an image by reading a file.

Parameters:

filename

The name of the file to be read.

Definition at line 57 of file jpeg.cc.

image::pointer image_format_jpeg::create_blank	(	int	width,
		int	height
	)		[static]

The create_blank class method is used to create a new image which is entirely blank (and transparent).

Parameters:

width	The width of the image
height	The height of the image

Definition at line 177 of file jpeg.cc.

image_format_jpeg& image_format_jpeg::operator=

(

const image_format_jpeg &

)

[private]

The assignment operator. Do not use.

void image_format_jpeg::save_to_file

(

const std::string &

filename

)

const [protected, virtual]

The save_to_file method is used to store the image data into a file on disk.

Parameters:

filename

The name of the file to be written.

Reimplemented from image_format.

Definition at line 128 of file jpeg.cc.

const char * image_format_jpeg::type_name

(

)

const [protected, virtual]

The type_name method is used to obtain the name of the type of this image format.

Implements image.

Definition at line 49 of file jpeg.cc.

---

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

• lib/image/format/jpeg.h
• lib/image/format/jpeg.cc