EngPaint function (winddi.h)

The EngPaint function causes GDI to paint a specified region.

Syntax

ENGAPI BOOL EngPaint(
       SURFOBJ  *pso,
       CLIPOBJ  *pco,
       BRUSHOBJ *pbo,
       POINTL   *pptlBrushOrg,
  [in] MIX      mix
);

Parameters

pso

Pointer to a SURFOBJ structure that describes the surface on which to draw.

pco

Pointer to a CLIPOBJ structure that defines the area to be painted. The CLIPOBJ_Xxx service routines are provided to enumerate the clip region as a set of rectangles.

pbo

Pointer to a BRUSHOBJ structure that defines the pattern and colors with which to fill.

pptlBrushOrg

Pointer to a POINTL structure that defines the brush origin used to align the brush pattern on the device.

[in] mix

Defines the foreground and background raster operations to use for the brush.

Return value

The return value is TRUE if the function is successful. Otherwise, it is FALSE, and an error code is logged.

Remarks

Vector device drivers can implement this function with the help of EngCreatePath and PATHOBJ_Xxx service routines.

The mix mode defines how the incoming pattern should be mixed with the data already on the device surface. The MIX data type consists of two ROP2 values packed into a single ULONG. The low-order byte defines the foreground raster operation; the next byte defines the background raster operation. For more information about raster operation codes, see the Microsoft Windows SDK documentation.

Requirements

See also

BRUSHOBJ

CLIPOBJ

EngCreatePath

PATHOBJ

SURFOBJ