GPE::Line()

This function is called before and after a sequence of line segments which are drawn as a path. When called before a line sequence, phase will have the value gpePrepare. Once the sequence is complete, the function is called with gpeComplete in the phase parameter.

Syntax

SCODE GPE::Line( GPELineParms *pLineParms, EGPEPhase phase );

The GPE::Line function examines the line parameters to determine whether the operation can be accelerated, and places the address of the function which will is to be called once per line segment into the pLine field of the GPELineParms structure. To use the emulated line drawing code supplied as part of GPE, the following code should be executed:

pLineParms->pLine = EmulatedLine;
return S_OK;

If pBltParms->prclClip is not NULL, then this sequence of lines will be clipped to a simple (i.e. single) cliprect. In this case, if hardware acceleration of the line drawing is being performed, and the hardware provides clipping (scissors) registers, the driver may prepare the clipping registers appropriately, the place NULL in pBltParms->prclClip so that GPE sill not attempt to clip the individual line segments.