DrvCopyBits function (winddi.h)

The DrvCopyBits function translates between device-managed raster surfaces and GDI standard-format bitmaps.

Syntax

BOOL DrvCopyBits(
  SURFOBJ  *psoDest,
  SURFOBJ  *psoSrc,
  CLIPOBJ  *pco,
  XLATEOBJ *pxlo,
  RECTL    *prclDest,
  POINTL   *pptlSrc
);

Parameters

psoDest

Pointer to the destination SURFOBJ structure for the copy operation.

psoSrc

Pointer to the source SURFOBJ structure for the copy operation.

pco

Pointer to a CLIPOBJ structure that defines a clip region on the destination surface.

pxlo

Pointer to an XLATEOBJ structure that defines the translation of color indices between the source and target surfaces. If pxlo is NULL, no translation is needed.

prclDest

Pointer to a RECTL structure that defines the area to be modified. This structure uses the coordinate system of the destination surface. The lower and right edges of this rectangle are not part of the bit-block transfer, meaning the rectangle is lower right exclusive.

DrvCopyBits is never called with an empty destination rectangle. The two points that define the rectangle are always well-ordered.

pptlSrc

Pointer to a POINTL structure that defines the upper-left corner of the source rectangle.

Return value

The return value is TRUE if the source surface is successfully copied to the destination surface.

Remarks

The driver may optionally hook DrvCopyBits. If so, GDI will call DrvCopyBits when it needs to copy from one surface to another and at least one of the surfaces is device-managed.

Requirements

Requirement Value
Target Platform Desktop
Header winddi.h (include Winddi.h)

See also

CLIPOBJ

XLATEOBJ