Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 10.1   10.2   10.3   10.4   10.5   11.0   11.1   11.2   11.3   11.4    Statistic    FMM    Blog  

GMImage.ClipMask

Associate a clip mask with the image.

Component Version macOS Windows Linux Server iOS SDK
GraphicsMagick 2.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "GMImage.ClipMask"; ImageRef; clipMask )   More

Parameters

Parameter Description Example
ImageRef The image reference number. 1
clipMask The image reference number. 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.

See also

Created 18th August 2014, last changed 18th August 2014


GMImage.Chop - GMImage.ClipPath

Feedback: Report problem or ask question.