IGR_Canvas_SetOpacity¶

Set the opacity/transparency for future drawing routines.

Prototype¶

C/C++

IGR_LONG IGR_Canvas_SetOpacity(
    HCANVAS canvas,
    BYTE opacity,
    Error_Control_Block* error);

Canvas: HCANVAS

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

Opacity: BYTE

Indicates the opacity value between 0 and 255, where 255 is opaque.

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.

The opacity is expressed as a number between 0 and 255. 255 indicates that that there is no transparency and 0 indicates full transparency.

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