gml_Bitmap_operations.h

Go to the documentation of this file.
00001 /**
00002  * @file gml_Bitmap_operations.h
00003  *
00004  *  Operations on bitmaps (gml_TBitmap).
00005  *
00006  * Copyright (c) 2003-2004 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 September 21, 2004 (FB).
00012  */
00013 
00014 #ifndef __GML_BITMAP_OPERATIONS__
00015 #define __GML_BITMAP_OPERATIONS__
00016 
00017 #include "gml/base/gml_Errors.h"
00018 #include "gml/image/gml_Geometry.h"
00019 #include "gml/image/gml_Bitmap.h"
00020 #include "gml/image/gml_RGBColor.h"
00021 
00022 
00023 
00024 
00025 /* in "gml_Bitmap_copy.cc" */
00026 
00027 /**
00028  * gml_Bitmap_Copy --
00029  *
00030  *  Copy one bitmap on another one. Pixel value conversion is done if necessary.
00031  *  @param  src       the source bitmap.
00032  *  @param  dst       the destination bitmap.
00033  *  @param  srcROI    a rectangular region of interest in the source bitmap,
00034  *                    NULL means the entire bitmap.
00035  *  @param  dstROI    a rectangular region of interest int the destination bitmap,
00036  *                    NULL means the entire bitmap.
00037  *                    <srcROI> and <dstROI> must have the same size.
00038  */
00039 GML_EXTERN_C
00040 gml_TError gml_Bitmap_Copy (gml_TBitmap*          src,
00041                             gml_TBitmap*          dst,
00042                             gml_TRect*            srcROI,
00043                             gml_TRect*            dstROI);
00044 
00045 
00046 
00047 /* in "gml_Bitmap_copyChannel.cc" */
00048 
00049 /**
00050  * gml_Bitmap_CopyChannel --
00051  *
00052  *  Copy one bitmap channel onto another bitmap channel.
00053  *  @param  src         the source bitmap.
00054  *  @param  dst         the destination bitmap. Maybe same as <src>.
00055  *  @param  srcChannel  number of the channel to be copied from the source bitmap.
00056  *  @param  dstChannel  number of the channel where to copy on the destination bitmap.
00057  *  @param  srcROI      a rectangular region of interest in the source bitmap,
00058  *                      NULL means the entire bitmap.
00059  *  @param  dstROI      a rectangular region of interest int the destination bitmap,
00060  *                      NULL means the entire bitmap.
00061  *                      <srcROI> and <dstROI> must have the same size.
00062  */
00063 GML_EXTERN_C
00064 gml_TError gml_Bitmap_CopyChannel  (gml_TBitmap*          src,
00065                                     gml_TBitmap*          dst,
00066                                     int                   srcChannel,
00067                                     int                   dstChannel,
00068                                     gml_TRect*            srcROI,
00069                                     gml_TRect*            dstROI);
00070 
00071 
00072 
00073 /* in "gml_Bitmap_draw.cc" */
00074 
00075 /**
00076  * gml_Bitmap_Fill --
00077  *
00078  *  Fills the pixels of a bitmap, inside a rectangle, with a specified color and alpha value.
00079  *  @param  bm          the bitmap to be filled.
00080  *  @param  c           the color, if NULL, black (0 values) is used.
00081  *  @param  alpha       the alpha (transparency) value. If NULL, 255 (full opaque)
00082  *                      is used. If the pixels have no alpha channel, <alpha> is
00083  *                      ignored.
00084  *  @param  roi         the rectangle to fill within the bitmap. If NULL, the entire
00085  *                      bitmap is filled.
00086  */
00087 GML_EXTERN_C
00088 gml_TError gml_Bitmap_Fill (gml_TBitmap*    bm,
00089                             gml_TRGBColor*  c,
00090                             UInt8*          alpha,
00091                             gml_TRect*      roi);
00092 
00093 
00094 
00095 #endif