This reference page is linked to from the following overview topics: Utility Classes.

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.

#include <fbimage.h>

Inheritance diagram for FBImage:

[legend]

List of all members.

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.
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]

Search for all occurrences

Virtual FBDelete function.

Reimplemented from FBComponent.

void Cleanup ( )

Search for all occurrences

Cleanup image data, making it black.

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

Search for all occurrences

Init.

Parameters:

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

unsigned char* GetDataBuffer ( )

Search for all occurrences

Access image data buffer, allow modifications.

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

bool ConvertFormat ( FBImageFormat pNewFormat )

Search for all occurrences

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
	)

Search for all occurrences

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 ( )

Search for all occurrences

Flip the image vertically.

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

Search for all occurrences

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.