SetClipHeight

Synopsis

Err SetClipHeight (Item bitmapItem,int32 clipHeight)

Description

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

After setting the clip width and height, rendering to the bitmap (both 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.

clipHeight: Value for the new clip height 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