Edit

EngCopyBits function (winddi.h)

  • Article

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

Syntax

ENGAPI BOOL EngCopyBits(
       SURFOBJ  *psoDest,
       SURFOBJ  *psoSrc,
       CLIPOBJ  *pco,
       XLATEOBJ *pxlo,
  [in] RECTL    *prclDest,
  [in] POINTL   *pptlSrc
);

Parameters

psoDest

Pointer to a SURFOBJ structure that describes the destination surface for the copy operation.

psoSrc

Pointer to a SURFOBJ structure that describes the source surface for the copy operation.

pco

Pointer to a CLIPOBJ structure that restricts the area of the destination surface that will be affected. This parameter can be NULL.

pxlo

Pointer to a XLATEOBJ structure that defines the translation of color indices between the source and target surfaces.

[in] prclDest

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

[in] 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 function is successful. If it is unsuccessful, it logs an error and returns FALSE.

Remarks

Standard-format bitmaps are single-plane, packed-pixel format. Each scan line is aligned on a 4-byte boundary. These bitmaps have 1, 4, 8, 16, 24, or 32 bits per pixel. See the EngCreateBitmap function for a list of standard format types.

GDI calls this function from its simulations.

EngCopyBits should not be called with an empty destination rectangle, and the two points of the destination rectangle must be well-ordered; that is, the first point should represent the upper-left vertex of the rectangle, and the second should represent the lower-right vertex.

Requirements

Requirement Value
Minimum supported client Available in Windows 2000 and later versions of the Windows operating systems.
Target Platform Universal
Header winddi.h (include Winddi.h)
Library Win32k.lib
DLL Win32k.sys

See also

CLIPOBJ

SURFOBJ

XLATEOBJ