gml_Bitmap_scans.h File Reference

Detailed Description

Common definition to all scan operations on bitmaps (gml_TBitmap).


Functions
GML_EXTERN_C gml_TError	gml_Bitmap_Scan_SetupParameters (gml_TBitmap bitmap, gml_TRect roi, UInt8 *lPtr, UInt32 width, UInt32 height, int pixelSize, SInt32 *rowOffset)
	Sets up parameters for a scan of a bitmap: a scan is a processing of every pixels of the bitmap, line by line (top to bottom), left to right.

GML_EXTERN_C gml_TError gml_Bitmap_Scan_SetupParameters	(	gml_TBitmap *	bitmap,
		gml_TRect *	roi,
		UInt8 **	lPtr,
		UInt32 *	width,
		UInt32 *	height,
		int *	pixelSize,
		SInt32 *	rowOffset
	)

Sets up parameters for a scan of a bitmap: a scan is a processing of every pixels of the bitmap, line by line (top to bottom), left to right.

Parameters:

	bitmap	is the bitmap to be scanned.
	roi	defines the rectangular Region Of Interest to be processed. If NULL, the scan is setup for the entire bitmap.
	lPtr	receives a pointer to the first pixel to be processed.
	width	receives the number of row of pixels to process. May be smaller than the width of the bitmap if roi is not NULL.
	height	receives the number of line of pixels to process.
	pixelSize	receives the size, in byte, of a pixel.
	rowOffset	receives the number of bytes to add to go from one line to the next line. negative if the bitmap lines are ordered from bottom to top in memory. rowOffset is typically added to lPtr to move to the first pixel of the next line to be processed.

Calls "gml_BitmapInitialize"