CheckBitmapBits

[This is preliminary documentation and subject to change.]

The CheckBitmapBits function checks whether the pixels in a specified bitmap lie within the output gamut of a specified transform.

BOOL WINAPI CheckBitmapBits(
  HTRANSFORM hColorTransform,
  PVOID pSrcBits,
  BMFORMAT bmInput, 
  DWORD dwWidth,
  DWORD dwHeight, 
  DWORD dwStride, 
  PBYTE paResult,
  PBMCALLBACKFN pfnCallback, 
  LPARAM lpCallbackData
);
 

Parameters

hColorTransform

Handle to the color transform to use.

pSrcBits

Pointer to the bitmap to check against the output gamut.

bmInput

Specifies the format of the bitmap. Must be set to one of the values of the BMFORMAT enumerated type.

dwWidth

Specifies the number of pixels per scan line of the bitmap.

dwHeight

Specifies the number of scan lines of the bitmap.

dwStride

Specifies the number of bytes from the beginning one scan line to the beginning of the next one. If set to zero, the bitmap scan lines are assumed to be padded so as to be DWORD-aligned.

paResult

Pointer to an array of bytes where the test results are to be placed. This results buffer must contain at least as many bytes as there are pixels in the bitmap.

pfnCallback

Pointer to a callback function called periodically by CheckBitmapBits to report progress and allow the calling process to cancel the bitmap test. (See ICMProgressProcCallback)

lpCallbackData

Data passed back to the callback function, for example, to identify the bitmap test about which progress is being reported.

Return Values

If this function succeeds, the return value is a nonzero value.

If this function fails, the return value is zero. For extended error information, call GetLastError.

Remarks

If the input format is not compatible with the color transform, the CheckBitmapBits function fails.

This function places results of the tests in the buffer pointed to by paResult. Each byte in the buffer corresponds to a pixel in the bitmap, and has an unsigned value between 0 and 255. The value 0 denotes that the color is in gamut, while a nonzero value denotes that it is out of gamut. For any integer n such that 0 < n < 255, a result value of n + 1 indicates that the corresponding color is at least as far out of gamut as would be indicated by a result value of n.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in icm.h.
  Import Library: Use mscms.lib.

See Also

Color Management Overview, ICM 2.0 Functions, ICMProgressProcCallback, BMFORMAT