L_DesaturateBitmap

#include "l_bitmap.h"

L_INT EXT_FUNCTION L_DesaturateBitmap(pBitmap)

/* pointer to the bitmap handle */

Converts the image to a grayscale level by reducing the saturation of each color to zero. The conversion will not change the color resolution.

Parameter	Description
pBitmap	Pointer to the bitmap handle that references the bitmap on which to apply the effect.

Returns

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

Comments

The bitmap is converted to a grayscale level by reducing the saturation of each color to zero.

This function supports only RGB images. It does not support grayscale images.

Support for 48-bit and 64-bit colored images are available only in the Document/Medical toolkits.

To update a status bar or detect a user interrupt during execution of this function, refer to L_SetStatusCallback.

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.

Required DLLs and Libraries

LTIMG

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 95 / 98 / Me, Windows 2000 / XP.

See Also

Functions:	L_BalanceColors, L_GrayScaleBitmap, L_GrayScaleBitmapExt, L_IsGrayScaleBitmap, L_AutoColorLevelBitmap, L_ColorLevelBitmap, L_CorrelationBitmap, L_GrayScaleToDuotone, L_GrayScaleToMultitone, L_HolesRemovalBitmapRgn, L_SelectiveColorBitmap, L_SkeletonBitmap
Topics:	Raster Image Functions: Modifying Intensity Values
	Grayscale Images
	Color Halftone and Halftone Images

Example

BITMAPHANDLE LeadBitmap; /* Bitmap handle for the image */

/* Load a bitmap at its own bits per pixel */
L_LoadBitmap(TEXT("IMAGE3.CMP"), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL);

/* Apply deSaturate effect on the image*/
L_DesaturateBitmap(&LeadBitmap);