L_ColorBitmapRgn

#include "l_bitmap.h"

L_LTDIS_API L_INT L_ColorBitmapRgn(hDC, pBitmap, pXForm, crRgnColor)

L_HDC hDC;	/* handle to the device context for display */
pBITMAPHANDLE pBitmap;	/* pointer to the bitmap */
pRGNXFORM pXForm;	/* pointer to a coordinate translation structure */
L_COLORREF crRgnColor;	/* color value */

Highlights a region by displaying a filled, color representation of the region.

Parameter	Description
hDC	Handle to a device context where the image is displayed and where the frame is to appear.
pBitmap	Pointer to the bitmap handle referencing the bitmap that has the region.
pXForm	Pointer to an RGNXFORM structure that LEADTOOLS uses to translate between display coordinates and bitmap coordinates.
	If you specify NULL in this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to the bitmap's view perspective.
crRgnColor	Color value to be XORed with colors within a region to determine the new colors for displaying the region. The color corresponding to a particular part of the region is determined as follows:
	Region Color Displayed = (color of pixel in region) XOR (crRgnColor)

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function does not support signed data images. It returns the error code ERROR_SIGNED_DATA_NOT_SUPPORTED if a signed data image is passed to this function.

This function is particularly useful when displaying regions with black and white images. All black pixels in a region are displayed with color crRgnColor, and all white pixels are displayed ~(crRgnColor). For example, suppose that crRgnColor is light green (BGR 0x80FF40). All black pixels in the region are displayed as crRgnColor. All white pixels in the region are displayed as 0xFFFFFF XOR 0x80FF40 = 0x7F00BF, which is purple.

Required DLLs and Libraries

LTDIS

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Windows 2000 / XP/Vista.

See Also

Functions:	L_FrameBitmapRgn()
Topics:	Raster Image Functions: Displaying Images
	Defining and Using a Bitmap Region
	Using Color Values in LEADTOOLS

Example

The following should be part of the WM_PAINT processing.

 L_INT ColorBitmapRgnExample(HWND            hWnd, pBITMAPHANDLE   pBitmap)
{
   L_INT nRet;
   HDC         hdcDraw;   
   COLORREF    crRgnColor = RGB(255,0,0);

   if(L_BitmapHasRgn(pBitmap))
   {
      hdcDraw = GetDC(hWnd);
      nRet = L_ColorBitmapRgn(hdcDraw, pBitmap, NULL, crRgnColor);
      if(nRet != SUCCESS)
         return nRet;
      ReleaseDC(hWnd, hdcDraw);
   }
   return SUCCESS;
}