FBImage Class Reference

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.

Public Member Functions
	FBImage (str pFileName)
	Constructor.
	Cleanup ()
	Cleanup image data, making it black.
bool	ConvertFormat (FBImageFormat pNewFormat)
	Convert the image data format to another format.
bool	ConvertSize (int pWidth, int pHeight)
	Convert the image size.
	FBDelete ()
	Virtual FBDelete function.
bool	Init (FBImageFormat pFormat, int pWidth, int pHeight)
	Init.
bool	IsCompressedTif (str pFileName)
	Query TIF file about its compressed status.
	VerticalFlip ()
	Flip the image vertically.
bool	WriteToTif (str pFileName, str pComments, bool pCompressed)
	Write image data to a TIF file on disk.
Public Attributes
int	Depth
	Read Write Property: Color depth of the image.
FBImageFormat	Format
	Read Write Property: Image data format.
int	Height
	Read Write Property: Height of the image in pixels.
FBImageInterleaveType	InterleaveType
	Read Only Property: Image interleave type. Only meaningful if image type is field.
FBImageInterpolationType	InterpolationType
	Read Only Property: Image interpolation type.
FBImageType	Type
	Read Only Property: Image type, refering to either frame or field.
int	Width
	Read Write Property: Width of the image in pixels.

---

Constructor & Destructor Documentation

FBImage

(

str

pFileName

)

Constructor.

Parameters:

pFileName

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

---

Member Function Documentation

Cleanup

(

)

Cleanup image data, making it black.

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.

FBDelete

(

)

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

Reimplemented from FBComponent.

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.

bool IsCompressedTif

(

str

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.

VerticalFlip

(

)

Flip the image vertically.

bool WriteToTif	(	str	pFileName,
		str	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.

---

Member Data Documentation

int Depth

Read Write Property: Color depth of the image.

FBImageFormat Format

Read Write Property: Image data format.

int Height

Read Write Property: Height of the image in pixels.

FBImageInterleaveType InterleaveType

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

FBImageInterpolationType InterpolationType

Read Only Property: Image interpolation type.

FBImageType Type

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

int Width

Read Write Property: Width of the image in pixels.

---