Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 3.58 KB

nf-winddi-pathobj_benumcliplines.md

File metadata and controls

95 lines (67 loc) · 3.58 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winddi.PATHOBJ_bEnumClipLines
PATHOBJ_bEnumClipLines function (winddi.h)
The PATHOBJ_bEnumClipLines function enumerates clipped line segments from a given path.
PATHOBJ_bEnumClipLines
PATHOBJ_bEnumClipLines function [Display Devices]
display.pathobj_benumcliplines
gdifncs_39da05f4-124b-4d0f-b33b-777220462aa7.xml
winddi/PATHOBJ_bEnumClipLines
display\pathobj_benumcliplines.htm
display
edc64b1e-dd3f-4b6a-858c-91c49a819b0a
12/05/2018
PATHOBJ_bEnumClipLines, PATHOBJ_bEnumClipLines function [Display Devices], display.pathobj_benumcliplines, gdifncs_39da05f4-124b-4d0f-b33b-777220462aa7.xml, winddi/PATHOBJ_bEnumClipLines
winddi.h
Winddi.h
Universal
Available in Windows 2000 and later versions of the Windows operating systems.
Win32k.lib
Win32k.sys
Windows
19H1
PATHOBJ_bEnumClipLines
winddi/PATHOBJ_bEnumClipLines
c++
APIRef
kbSyntax
DllExport
Win32k.sys
PATHOBJ_bEnumClipLines

PATHOBJ_bEnumClipLines function

-description

The PATHOBJ_bEnumClipLines function enumerates clipped line segments from a given path.

-parameters

-param ppo

Pointer to the PATHOBJ structure containing the clipped line segments that are to be enumerated.

-param cb

Specifies the size of the output buffer, in bytes. GDI does not write beyond this point in the buffer. The value of this parameter must be large enough to hold a CLIPLINE structure with at least one RUN structure. The driver should allocate space for several RUN structures.

-param pcl

Pointer to the buffer that receives a CLIPLINE structure. The structure contains the original unclipped control points for a line segment. (The correct pixels for the line cannot be computed without the original points.) RUN structures, which describe sets of pixels along the line that are not clipped away, are written to this buffer.

If a clip region is complex, a single line segment can be broken into many RUN structures. A segment is returned as many times as necessary to list all of its RUN structures.

The CLIPLINE structure contains the starting and ending points of the original unclipped line and the line segments, or RUN structures, of that line that are to appear on the display.

-returns

The return value is TRUE if more line segments are to be enumerated, indicating that this service should be called again. Otherwise, it is FALSE, indicating that the returned segment is the last segment in the path.

-remarks

The enumeration must be started with PATHOBJ_vEnumStartClipLines before the driver makes this call.

-see-also

CLIPLINE

PATHOBJ

PATHOBJ_vEnumStartClipLines

RUN