Skip to content

IGR_Canvas_Reset

IGR_Canvas_Reset restores the canvas object back to the default set of options, including opacity, rotation, pens, and brushes.

Prototype

IGR_LONG IGR_Canvas_Reset(
    HCANVAS canvas,
    Error_Control_Block* error);

Parameters

Canvas: HCANVAS

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

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

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