FBImage Class Reference

#include <fbimage.h>

FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage FBImage

Inheritance diagram for FBImage:

[legend]

List of all members.

---

Detailed Description

Image class.

Utility class used to load and get manipulate image data from disk or memory.

Definition at line 104 of file fbimage.h.

Public Member Functions
	FBImage (char *pFileName, HIObject pObject=NULL)
	Constructor.
virtual void	FBDelete ()
	Virtual FBDelete function.
void	Cleanup ()
	Cleanup image data, making it black.
bool	Init (FBImageFormat pFormat, int pWidth, int pHeight)
	Init.
unsigned char *	GetDataBuffer ()
	Access image data buffer, allow modifications.
bool	ConvertFormat (FBImageFormat pNewFormat)
	Convert the image data format to another format.
bool	ConvertSize (int pWidth, int pHeight)
	Convert the image size.
void	VerticalFlip ()
	Flip the image vertically.
bool	WriteToTif (char *pFileName, char *pComments, bool pCompressed)
	Write image data to a TIF file on disk.
bool	IsCompressedTif (char *pFileName)
	Query TIF file about its compressed status.
Public Attributes
FBPropertyInt	Width
	Read Write Property: Width of the image in pixels.
FBPropertyInt	Height
	Read Write Property: Height of the image in pixels.
FBPropertyInt	Depth
	Read Write Property: Color depth of the image.
FBPropertyImageFormat	Format
	Read Write Property: Image data format.
FBPropertyImageType	Type
	Read Only Property: Image type, refering to either frame or field.
FBPropertyImageInterleaveType	InterleaveType
	Read Only Property: Image interleave type. Only meaningful if image type is field.
FBPropertyImageInterpolationType	InterpolationType
	Read Only Property: Image interpolation type.

---

Constructor & Destructor Documentation

FBImage	(	char *	pFileName,
		HIObject	pObject = NULL
	)

Constructor.

Parameters:

	pFileName	Path to the image file. If pObject is not NULL, pFileName will be ignored.
	pObject	For internal use only.

---

Member Function Documentation

virtual void FBDelete

(

)

[virtual]

Virtual FBDelete function.

Reimplemented from FBComponent.

void Cleanup

(

)

Cleanup image data, making it black.

bool Init	(	FBImageFormat	pFormat,
		int	pWidth,
		int	pHeight
	)

Init.

Parameters:

	pFormat	Image format used to initialize data buffer.
	pWidth	Image width in pixels.
	pHeight	Image height in pixels.

unsigned char* GetDataBuffer

(

)

Access image data buffer, allow modifications.

Returns:

Pointer to the image data, values ranging from 0 to 255.

bool ConvertFormat

(

FBImageFormat

pNewFormat

)

Convert the image data format to another format.

Parameters:

pNewFormat

The new format to convert the image to.

Returns:

Return true if the convert was successful.

bool ConvertSize	(	int	pWidth,
		int	pHeight
	)

Convert the image size.

Parameters:

	pWidth	New width of the image.
	pHeight	New height of the image.

Returns:

Return true if the convert was successful.

void VerticalFlip

(

)

Flip the image vertically.

bool WriteToTif	(	char *	pFileName,
		char *	pComments,
		bool	pCompressed
	)

Write image data to a TIF file on disk.

Parameters:

	pFileName	Full TIF file path name of the file to write.
	pComments	Comments appended to the TIF file.
	pCompressed	If true, the image data in the file will be compressed.

Returns:

Return true if the image was successfully written on disk.

bool IsCompressedTif

(

char *

pFileName

)

Query TIF file about its compressed status.

Parameters:

pFileName

Full TIF file path name of the file to query.

Returns:

Return true if the TIF file image data is compressed.

---

Member Data Documentation

FBPropertyInt Width

Read Write Property: Width of the image in pixels.

Definition at line 170 of file fbimage.h.

FBPropertyInt Height

Read Write Property: Height of the image in pixels.

Definition at line 171 of file fbimage.h.

FBPropertyInt Depth

Read Write Property: Color depth of the image.

Definition at line 172 of file fbimage.h.

FBPropertyImageFormat Format

Read Write Property: Image data format.

Definition at line 173 of file fbimage.h.

FBPropertyImageType Type

Read Only Property: Image type, refering to either frame or field.

Definition at line 174 of file fbimage.h.

FBPropertyImageInterleaveType InterleaveType

Read Only Property: Image interleave type. Only meaningful if image type is field.

Definition at line 175 of file fbimage.h.

FBPropertyImageInterpolationType InterpolationType

Read Only Property: Image interpolation type.

Definition at line 176 of file fbimage.h.

---

Please send us your comments about this page.