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: 12.1   12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3   13.4    Statistic    FMM    Blog  

GMImage.SetMonochrome

If set, transform image to black and white.

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

Parameters

Parameter Description Example
ImageRef The image reference number. 1
flag A boolean value. 1

Result

Returns "OK" on success.

Description

If set, transform image to black and white.

Examples

Three ways to make a black & white image:

# make black and white with threshold
Set Variable [$r; Value: MBS("GMImage.Threshold";$Image; 127) ]

# mark as monochrome image
Set Variable [$r; Value: MBS("GMImage.SetMonochrome";$Image; 1) ]

# set type to 1 for black/white
Set Variable [$r; Value: MBS("GMImage.SetType";$Image; 1) ]

See also

This function checks for a license.

Created 18th August 2014, last changed 3th February 2023


GMImage.SetModulusDepth - GMImage.SetOrientation

💬 Ask a question or report a problem