Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function paints the given rectangle using the brush that is currently selected into the specified device context. The brush pixels and the surface pixels are combined according to the specified raster operation.

Syntax 

BOOL PatBlt(
  HDC 
hdc, 
  int 
nXLeft, 
  int 
nYLeft, 
  int 
nWidth, 
  int 
nHeight, 
  DWORD 
dwRop
);

Parameters

hdc

[in] Handle to the device context.

nXLeft

[in] Specifies the x-coordinate, in logical units, of the upper-left corner of the rectangle to be filled.

nYLeft

[in] Specifies the y-coordinate, in logical units, of the upper-left corner of the rectangle to be filled.

nWidth

[in] Specifies the width, in logical units, of the rectangle.

nHeight

Specifies the height, in logical units, of the rectangle.

dwRop

[in] Specifies the raster operation code.

This code may be one of the following values.

Value Description

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 OR operator.

DSTINVERT

Inverts the destination rectangle.

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.

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.

Remarks

The values of the dwRopparameter for this function are a limited subset of the full 256 ternary raster-operation codes; in particular, an operation code that refers to a source rectangle cannot be used.

Not all devices support the PatBltfunction.

For more information, see the description of the RC_BITBLT capability in the GetDeviceCapsfunction.

If hdcspecifies a mirrored device context, the horizontal coordinates increase from right to left rather than from left to right.

For information about blitting to displays with right-to-left orientations, see Creating Bitmaps.

Requirements

Header windows.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also