EngLineTo function (winddi.h)

Article
02/22/2024

The EngLineTo function draws a single, solid, integer-only cosmetic line.

Syntax

ENGAPI BOOL EngLineTo(
  SURFOBJ  *pso,
  CLIPOBJ  *pco,
  BRUSHOBJ *pbo,
  LONG     x1,
  LONG     y1,
  LONG     x2,
  LONG     y2,
  RECTL    *prclBounds,
  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 clip region in which the rendering must be done. No pixels can be affected outside this clip region.

pbo

Pointer to a BRUSHOBJ structure that specifies the brush to use when drawing the line.

x1

Specify the integer x-coordinate of the line's beginning point.

y1

Specify the integer y-coordinate of the line's beginning point.

x2

Specify the integer x-coordinate of the line's end point.

y2

Specify the integer x- and y-coordinate of the line's end point.

prclBounds

Pointer to a RECTL structure that describes the rectangle that bounds the unclipped line. Drivers that support hardware line drawing can use this rectangle to quickly determine whether the line fits in a coordinate space small enough to be rendered by the hardware.

mix

Defines how the incoming pattern should be mixed with the data already on the device surface. The low-order byte defines the raster operation. For more information about raster operation codes, see the Microsoft Windows SDK documentation.

Return value

EngLineTo returns TRUE if it succeeds; otherwise, it returns FALSE.

Remarks

The driver that has hooked DrvLineTo can call EngLineTo when the rendering surface is a device-independent bitmap (DIB).

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