Share via


GPE::Line (Compact 2013)

3/26/2014

This method executes before and after a sequence of line segments, which are drawn as a path.

Syntax

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

Parameters

  • pLineParms
    [in] Pointer to a GPELineParms structure containing parameters for the line.
  • phase
    [in] Set to one of the values in the following table.

    Value

    Description

    gpeSingle

    For single lines.

    gpePrepare

    For initializing the display hardware to draw several lines with similar parameters.

    gpeContinue

    For lines that are part of a sequence of line drawing operations.

    gpeComplete

    Signals the end of a sequence of line drawing operations.

Return Value

None.

Remarks

This is the only pure virtual line drawing method that you must overload in a GPE-based driver.

When called before a line sequence, the phase parameter has the value gpePrepare. Once the sequence is complete, the graphics device interface (GDI) calls this method with the value gpeComplete in the phase parameter.

The GPE::Line method examines the line parameters to determine whether the operation can be accelerated. It also places a pointer to a function to execute once per line segment into the pLine member of the GPELineParms structure. To use the emulated line drawing code supplied as part of the GPE, execute the following code.

pLineParms->pLine = EmulatedLine;
return S_OK;

Requirements

Header

gpe.h

Library

Gpe_lib.lib

See Also

Reference

Display Driver Methods
GPELineParms