IGR_Canvas_SetPen¶

Updates the canvas pen on the canvas with the specific color, width and style.

Prototype¶

IGR_LONG IGR_Canvas_SetPen(
    HCANVAS canvas,
    IGR_LONG color,
    IGR_LONG width,
    IGR_LONG style,
    Error_Control_Block* error);

Parameters¶

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Color: IGR_LONG

The color expressed as a 32-bit integer.

Width: IGR_LONG

The width of the pen, expressed in points.

Style: IGR_LONG

The pen style used when drawing. See Pen Styles.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

Return value¶

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

Additional Information¶

Color is expressed as a 32-bit integer, where the 4 bytes represent Alpha, Red, Green and Blue components.

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not supported.

See also¶

• IGR_Canvas_SetBrush