All functions   Mac OS X   Windows   Crossplatform   Components   New in version: 1.0   1.1   1.2   1.3   1.4   1.5   1.6   1.7   1.8   2.0  

GMImage.ClipMask

Component: GraphicsMagick
Mac OS X: Works
Windows: Works

MBS( "GMImage.ClipMask"; ImageRef; clipMask )

Parameters

Parameter Description Example value
ImageRef The image reference (a number returned from the GMImage.New functions) 1
clipMask The image reference (a number returned from the GMImage.New functions) 2

Result

Returns "OK" on success.

Description

Associate a clip mask with the image. The clip mask must be the same dimensions as the image. Pass an invalid image to unset an existing clip mask.

Feedback: Report problem or ask question.