GMImage.SetMonochrome
---------------------

If set, transform image to black and white.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [GraphicsMagick](component_GraphicsMagick.md) | [2.0](newinversion20.md) | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |

MBS( "GMImage.SetMonochrome"; ImageRef; Flag ) 

**MBS**( **"GMImage.SetMonochrome";** /\* If set, transform image to black and white. \*/  
**$ImageRef**; /\* The image reference number.e.g. 1 \*/   
**$Flag**) /\* A boolean value.e.g. 1 \*/ 

### 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 &amp; white image:

 # make black and white with threshold   
Set Variable \[$r ; Value: MBS ("[GMImage.Threshold](GMImageThreshold.md)";$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](GMImageSetType.md)";$Image ; 1) \]  
### See also

- [GMImage.GetMonochrome](GMImageGetMonochrome.md)
- [GMImage.SetCompressType](GMImageSetCompressType.md)
- [GMImage.SetMagick](GMImageSetMagick.md)
- [GMImage.SetType](GMImageSetType.md)
- [GMImage.Threshold](GMImageThreshold.md)
- [GMImage.WriteToFile](GMImageWriteToFile.md)
- [GMImage.WriteToTiffContainer](GMImageWriteToTiffContainer.md)

This function checks for a license.

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

  
[GMImage.SetModulusDepth](GMImageSetModulusDepth.md) - [GMImage.SetOrientation](GMImageSetOrientation.md)

[HTML Version](GMImageSetMonochrome.shtml)