LBitmap::Desaturate

#include "ltwrappr.h"

virtual L_INT LBitmap::Desaturate(uFlags = 0)

/* flags */

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
uFlags	Reserved for future use. Must be 0.

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 LBase::EnableStatusCallback.

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 does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.

Required DLLs and Libraries

LTIMGCLR

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

Win32, x64.

See Also

Functions:	LBitmap::BalanceColors, LBitmap::GrayScaleExt, LBitmap::GrayScaleExt, LBitmapBase::IsGrayScale
Topics:	Raster Image Functions: Modifying Intensity Values
	Grayscale Images
	Color Halftones and Halftone Images
	Raster Image Functions: Working with Color Halftones, Halftones, and Grayscale Images

Example

L_INT LBitmap__DesaturateExample(LAnimationWindow *BitmapWindow) 
{
   
   return BitmapWindow->Desaturate();
}