SetClipWidth

Synopsis

Err SetClipWidth (Item bitmapItem,int32 clipWidth)

Description

This call uses the clipWidth argument to set the clip width of the bitmap specified by the bitmapItem argument. The clipWidth must be no greater than the width of the bitmap's buffer.

After setting the clip width and height, rendering to the bitmap, with the rendering primitives and with calls to the cel engine, is clipped to stay within the clip rectangle.

Arguments

bitmapItem: Item number of a bitmap structure.

clipWidth: Value for the new clip width for the bitmap.

Return Value

The call returns 0 if successful or an error code (a negative value) if an error occurs.

Implementation

Folio call implemented in Graphics folio V20.

Associated Files

graphics.h, graphics.lib