IGR_Canvas_SetBrush¶

Updates the current brush on the canvas with the given color and style; brushes are used when drawing rectangles, shapes and text.

Prototype¶

C/C++

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

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.

Style: IGR_LONG

The brush style used when drawing. See Brush Styles.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

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.