imagen - API Documentation

Raw image data. More...

#include <iRawImage.h>

Inheritance diagram for imagen::iRawImage:

List of all members.

Public Member Functions
	iRawImage ()
	Constructs a null image.
	iRawImage (const iRawImage &img)
	Copy constructor.
	iRawImage (const iAbstractImage &img)
	iAbstractImage copy constructor.
	iRawImage (int w, int h, iImageFormat f)
	Constructs an image with the given size and format.
	iRawImage (Iubyte *d, int w, int h, iImageFormat f, int b)
	Constructs an image using an existing memory buffer.
	~iRawImage ()
	Destructor.
void	clear ()
	Detaches this image from the image data and resets all data members to their initial values.
bool	isFormatSupported (iImageFormat fmt) const
	Checks whether or not a given image color format is supported by this image type.
iRawImage &	operator= (const iAbstractImage &img)
Protected Member Functions
void	init ()
bool	loadImage ()
bool	saveImage ()

Detailed Description

Raw image data.

This is not a conventional RAW image format like that used in digital cameras. It is merely a generic encapsulation of image data.

Constructor & Destructor Documentation

imagen::iRawImage::iRawImage ( )

Constructs a null image.

imagen::iRawImage::iRawImage ( const iRawImage & img )

Copy constructor.

This copies all image attributes, and attaches itself to img's shared data.

imagen::iRawImage::iRawImage ( const iAbstractImage & img )

iAbstractImage copy constructor.

imagen::iRawImage::iRawImage	(	int	w,
		int	h,
		iImageFormat	f
	)

Constructs an image with the given size and format.

The image data will be allocated, but not initialized.

Parameters:

w	: Image width.
h	: Image height.
f	: Image format.

imagen::iRawImage::iRawImage	(	Iubyte *	d,
		int	w,
		int	h,
		iImageFormat	f,
		int	b
	)

Constructs an image using an existing memory buffer.

The memory buffer will not be deleted at destruction.

See also:: loadData()

imagen::iRawImage::~iRawImage ( )

Destructor.

Member Function Documentation

void imagen::iRawImage::clear ( ) [virtual]

Detaches this image from the image data and resets all data members to their initial values.

Reimplemented from imagen::iAbstractImage.

bool imagen::iRawImage::isFormatSupported ( iImageFormat fmt ) const [inline, virtual]

Checks whether or not a given image color format is supported by this image type.

Returns:: True if the format is supported, else false.

Implements imagen::iAbstractImage.

iRawImage& imagen::iRawImage::operator= ( const iAbstractImage & img )

Reimplemented from imagen::iAbstractImage.

void imagen::iRawImage::init ( ) [protected]

Reimplemented from imagen::iAbstractImage.

bool imagen::iRawImage::loadImage ( ) [inline, protected, virtual]

Implements imagen::iAbstractImage.

bool imagen::iRawImage::saveImage ( ) [inline, protected, virtual]

Implements imagen::iAbstractImage.

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

iRawImage.h