BitBlt (Compact 2013)

3/28/2014

This function transfers pixels from a specified source rectangle to a specified destination rectangle, altering the pixels according to the selected raster operation (ROP) code.

Syntax

BOOL BitBlt(
  HDC hdcDest, 
  int nXDest, 
  int nYDest, 
  int nWidth, 
  int nHeight, 
  HDC hdcSrc, 
  int nXSrc, 
  int nYSrc, 
  DWORD dwRop
);

Parameters

• hdcDest
  [in] Handle to the destination device context.

• nXDest
  [in] Specifies the logical x-coordinate of the upper-left corner of the destination rectangle.

• nYDest
  [in] Specifies the logical y-coordinate of the upper-left corner of the destination rectangle.

• nWidth
  [in] Specifies the logical width of the source and destination rectangles.

• nHeight
  [in] Specifies the logical height of the source and the destination rectangles.

• hdcSrc
  [in] Handle to the source device context.

• nXSrc
  [in] Specifies the logical x-coordinate of the upper-left corner of the source rectangle.

• nYSrc
  [in] Specifies the logical y-coordinate of the upper-left corner of the source rectangle.

• dwRop
  [in] Specifies a raster-operation code.

  These codes define how the color data for the source rectangle is to be combined with the color data for the destination rectangle to achieve the final color.

  The following list shows some common raster operation codes.

  Value	Description
  BLACKNESS	Fills the destination rectangle using the color associated with index 0 in the physical palette. This color is black for the default physical palette.
  DSTINVERT	Inverts the destination rectangle.
  MERGECOPY	Merges the colors of the source rectangle with the specified pattern by using the Boolean AND operator.
  MERGEPAINT	Merges the colors of the inverted source rectangle with the colors of the destination rectangle by using the Boolean OR operator.
  NOTSRCCOPY	Copies the inverted source rectangle to the destination.
  NOTSRCERASE	Combines the colors of the source and destination rectangles by using the Boolean OR operator and then inverts the resultant color.
  PATCOPY	Copies the specified pattern into the destination bitmap.
  PATINVERT	Combines the colors of the specified pattern with the colors of the destination rectangle by using the Boolean XOR operator.
  PATPAINT	Combines the colors of the pattern with the colors of the inverted source rectangle by using the Boolean OR operator. The result of this operation is combined with the colors of the destination rectangle by using the Boolean OR operator.
  SRCAND	Combines the colors of the source and destination rectangles by using the Boolean AND operator.
  SRCCOPY	Copies the source rectangle directly to the destination rectangle.
  SRCERASE	Combines the inverted colors of the destination rectangle with the colors of the source rectangle by using the Boolean AND operator.
  SRCINVERT	Combines the colors of the source and destination rectangles by using the Boolean XOR operator.
  SRCPAINT	Combines the colors of the source and destination rectangles by using the Boolean OR operator.
  WHITENESS	Fills the destination rectangle using the color associated with index 1 in the physical palette. This color is white for the default physical palette.

  For the complete list of raster operations codes, see Ternary Raster Operations.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Code Example

The following code example shows how to use BitBlt to copy all of the pixels in one bitmap into another bitmap.

HBITMAP CopyBitmap( HBITMAP hbm) {
    HDC hdcSrc = CreateCompatibleDC(NULL);
    HDC hdcDst = CreateCompatibleDC(NULL);
    HBITMAP hbmOld, hbmOld2, hbmNew;
    BITMAP bm;
    GetObject(hbm, sizeof(bm), &bm);
    hbmOld = SelectObject(hdcSrc, hbm);
    hbmNew = CreateBitmap( bm.bmWidth, bm.bmHeight, bm.bmPlanes,
bm.bmBitsPixel,
            NULL);
    hbmOld2 = SelectObject(hdcDst, hbmNew);
    BitBlt(hdcDst, 0, 0, bm.bmWidth, bm.bmHeight, hdcSrc, 0, 0, SRCCOPY);
    SelectObject(hdcSrc, hbmOld);
    DeleteDC(hdcSrc);
    DeleteDC(hdcDst);
    return hbmNew;
}

Remarks

If a rotation or shear transformation is in effect in the source device context, BitBlt returns an error.

If other transformations exist in the source device context (and a matching transformation is not in effect in the destination device context), the rectangle in the destination device context is stretched, compressed, or rotated as necessary.

If the color formats of the source and destination device contexts do not match, the BitBlt function converts the source color format to match the destination format.

When an enhanced metafile is being recorded, an error occurs if the source device context identifies an enhanced-metafile device context.

Not all devices support the BitBlt function.

For more information, see the RC_BITBLT raster capability entry in the GetDeviceCaps function, as well as the MaskBlt and StretchBlt functions.

BitBlt returns an error if the source and destination device contexts represent different devices.

Requirements

See Also

Reference

GDI Functions
GetDeviceCaps
MaskBlt
StretchBlt
Ternary Raster Operations