gml_Bitmap_operations.h File Reference

Detailed Description

Operations on bitmaps (gml_TBitmap).


Functions
GML_EXTERN_C gml_TError	gml_Bitmap_Copy (gml_TBitmap src, gml_TBitmap dst, gml_TRect srcROI, gml_TRect dstROI)
	Copy one bitmap on another one.
GML_EXTERN_C gml_TError	gml_Bitmap_CopyChannel (gml_TBitmap src, gml_TBitmap dst, int srcChannel, int dstChannel, gml_TRect srcROI, gml_TRect dstROI)
	Copy one bitmap channel onto another bitmap channel.
GML_EXTERN_C gml_TError	gml_Bitmap_Fill (gml_TBitmap bm, gml_TRGBColor c, UInt8 alpha, gml_TRect roi)
	Fills the pixels of a bitmap, inside a rectangle, with a specified color and alpha value.

GML_EXTERN_C gml_TError gml_Bitmap_Copy	(	gml_TBitmap *	src,
		gml_TBitmap *	dst,
		gml_TRect *	srcROI,
		gml_TRect *	dstROI
	)

Copy one bitmap on another one.

Pixel value conversion is done if necessary.

Parameters:

	src	the source bitmap.
	dst	the destination bitmap.
	srcROI	a rectangular region of interest in the source bitmap, NULL means the entire bitmap.
	dstROI	a rectangular region of interest int the destination bitmap, NULL means the entire bitmap. srcROI and dstROI must have the same size.

GML_EXTERN_C gml_TError gml_Bitmap_CopyChannel	(	gml_TBitmap *	src,
		gml_TBitmap *	dst,
		int	srcChannel,
		int	dstChannel,
		gml_TRect *	srcROI,
		gml_TRect *	dstROI
	)

Copy one bitmap channel onto another bitmap channel.

Parameters:

	src	the source bitmap.
	dst	the destination bitmap. Maybe same as src.
	srcChannel	number of the channel to be copied from the source bitmap.
	dstChannel	number of the channel where to copy on the destination bitmap.
	srcROI	a rectangular region of interest in the source bitmap, NULL means the entire bitmap.
	dstROI	a rectangular region of interest int the destination bitmap, NULL means the entire bitmap. srcROI and dstROI must have the same size.

GML_EXTERN_C gml_TError gml_Bitmap_Fill	(	gml_TBitmap *	bm,
		gml_TRGBColor *	c,
		UInt8 *	alpha,
		gml_TRect *	roi
	)

Fills the pixels of a bitmap, inside a rectangle, with a specified color and alpha value.

Parameters:

	bm	the bitmap to be filled.
	c	the color, if NULL, black (0 values) is used.
	alpha	the alpha (transparency) value. If NULL, 255 (full opaque) is used. If the pixels have no alpha channel, alpha is ignored.
	roi	the rectangle to fill within the bitmap. If NULL, the entire bitmap is filled.