LBitmapSettings::DefaultDithering

#include "ltwrappr.h"

static L_INT LBitmapSettings::DefaultDithering(uMethod)

L_UINT uMethod;

/* the dithering method to use */

Specifies the default dithering method to use when converting an image from 64, 48, 32, 24, or 16 bits per pixel to 8 bits per pixel or fewer.

Parameter	Description
uMethod	The dithering method to use. Possible values are:
	Value	Meaning
	NO_DITHERING	[0] Use no dithering.
	FLOYD_STEIN_DITHERING	[1] Use the Floyd-Steinberg method.
	BURKES_DITHERING	[3] Use the Burkes method.
	STUCKI_DITHERING	[2] Use the Stucki method.
	SIERRA_DITHERING	[4] Use the Sierra method.
	STEVENSON_ARCE_DITHERING	[5] Use the Stevenson-Arce method.
	JARVIS_DITHERING	[6] Use the Jarvis method.
	ORDERED_DITHERING	[7] Use ordered dithering, which is faster than other methods but is lower in quality.
	CLUSTERED_DITHERING	[8] Use clustered dithering.

Returns

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

Comments

Some LEADTOOLS functions automatically dither an image when necessary for display. Those functions use the default dithering method that this function specifies.

For general information about dithering, refer to Color Resolution and Dithering.

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

Win32, x64.

See Also

Functions:	LBitmapBase::ColorRes, LBitmapSettings::CreateUserMatchTable, LBitmapSettings::SetUserMatchTable, LBitmapSettings::FreeUserMatchTable
Topics:	Raster Image Functions: Doing Color Expansion or Reduction
	Raster Image Functions: Doing Color Space Conversions
	Raster Image Functions: Palettes
	Color Resolution and Dithering
	Color Halftones and Halftone Images
	Raster Image Functions: Working with Color Halftones, Halftones, and Grayscale Images

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
L_INT LBitmapSettings__DefaultDitheringExample(HWND hWnd)
{
   L_INT nRet;
   LBitmapSettings bitmapSettings;
   LBitmap         LeadBitmap;
   // Set the default dithering 
  nRet =LBitmapSettings::DefaultDithering(NO_DITHERING);
  if(nRet < 0)
     return nRet;
   // Load the bitmap at 8 bits per pixel 
  nRet = LeadBitmap.Load(MAKE_IMAGE_PATH(TEXT("image1.cmp")), 8, ORDER_BGR);
  if(nRet !=SUCCESS)
     return nRet;
   // Update the paint palette
   SendMessage (hWnd, WM_QUERYNEWPALETTE, 0, 0L);
   return SUCCESS;
}