gml_Bitmap_scans.h

Go to the documentation of this file.
00001 /**
00002  * @file gml_Bitmap_scans.h
00003  *
00004  *  Common definition to all scan operations on bitmaps (gml_TBitmap).
00005  *
00006  * Copyright (c) 2003 CLIPS-IMAG
00007  *
00008  * See the file "gml_LicenseTerms.txt" for information on usage and redistribution
00009  * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
00010  *
00011  *  Created on Sept. 20, FB.
00012  */
00013 
00014 #ifndef __GML_BITMAP_SCANS__
00015 #define __GML_BITMAP_SCANS__
00016 #include "gml/base/gml_Errors.h"
00017 #include "gml/image/gml_Bitmap.h"
00018 #include "gml/image/gml_Geometry.h"
00019 
00020 
00021 /**
00022  * gml_Bitmap_Scan_SetupParameters --
00023  *
00024  *  Sets up parameters for a scan of a bitmap: a scan is a processing of
00025  *    every pixels of the bitmap, line by line (top to bottom), left to right.
00026  *  @param  bitmap      is the bitmap to be scanned.
00027  *  @param  roi         defines the rectangular Region Of Interest to be processed. If NULL, the
00028  *                      scan is setup for the entire bitmap.
00029  *  @param  lPtr        receives a pointer to the first pixel to be processed.
00030  *  @param  width       receives the number of row of pixels to process. May be smaller than
00031  *                      the width of the bitmap if <roi> is not NULL.
00032  *  @param  height      receives the number of line of pixels to process.
00033  *  @param  pixelSize   receives the size, in byte, of a pixel.
00034  *  @param  rowOffset   receives the number of bytes to add to go from one line to the next line.
00035  *                      negative if the bitmap lines are ordered from bottom to top in memory.
00036  *                      <rowOffset> is typically added to <lPtr> to move to the first pixel of
00037  *                      the next line to be processed.
00038  *
00039  *  Calls "gml_BitmapInitialize"
00040  */
00041 GML_EXTERN_C
00042 gml_TError gml_Bitmap_Scan_SetupParameters (gml_TBitmap*  bitmap,
00043                                             gml_TRect*    roi,
00044                                             UInt8**       lPtr,
00045                                             UInt32*       width,
00046                                             UInt32*       height,
00047                                             int*          pixelSize,
00048                                             SInt32*       rowOffset);
00049 
00050 
00051 #endif