GMImage.Modulate
----------------

Modulate percent hue, saturation, and brightness of an image.

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

MBS( "GMImage.Modulate"; ImageRef; brightness; saturation; hue ) 

**MBS**( **"GMImage.Modulate";** /\* Modulate percent hue, saturation, and brightness of an image. \*/  
**$ImageRef**; /\* The image reference number.e.g. 1 \*/   
**$brightness**; /\* The brightness value.e.g. 100 \*/   
**$saturation**; /\* The saturation value.e.g. 0 \*/   
**$hue**) /\* The hue value.e.g. 100 \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| ImageRef | The image reference number. | 1 |
| brightness | The brightness value. | 100 |
| saturation | The saturation value. | 0 |
| hue | The hue value. | 100 |

### Result

Returns "OK" on success.

### Description

Modulate percent hue, saturation, and brightness of an image.   
Modulation of saturation and brightness is as a ratio of the current value (100 for no change). Modulation of hue is an absolute rotation of -180 degrees to +180 degrees from the current position corresponding to an argument range of 0 to 200 (100 for no change).  
### Examples

Increase brightness:

 MBS ("GMImage.Modulate"; $Image ; 110; 100; 100);  
Increase saturation:

 MBS ("GMImage.Modulate"; $Image ; 100; 110; 100);  
Increase hue:

 MBS ("GMImage.Modulate"; $Image ; 100; 100; 110);  
Modulate an image:

 Set Variable \[ $image ; Value: MBS ("[GMImage.NewFromContainer](GMImageNewFromContainer.md)"; MyTable::InputImage ) \]   
Set Variable \[ $r ; Value: MBS ("GMImage.Modulate" ; $image ; 150 ; 150 ; 150 ) \]   
Set Field \[ MyTable::Brightened ; MBS ("[GMImage.WriteToJPEGContainer](GMImageWriteToJPEGContainer.md)";$image ) \]   
Set Variable \[ $r ; Value: MBS ("[GMImage.Release](GMImageRelease.md)"; $image ) \]  
### See also

- [GMImage.New](GMImageNew.md)
- [GMImage.NewFromContainer](GMImageNewFromContainer.md)
- [GMImage.Release](GMImageRelease.md)
- [GMImage.Rotate](GMImageRotate.md)
- [GMImage.WriteToJPEGContainer](GMImageWriteToJPEGContainer.md)

### Blog Entries

- [GraphicsMagick in FileMaker, part 18](https://www.mbsplugins.de/archive/2022-12-18/GraphicsMagick_in_FileMaker_pa/monkeybreadsoftware_blog_filemaker)

This function checks for a license.

Created 18th August 2014 , last changed 26th April 2019

  
[GMImage.Minify](GMImageMinify.md) - [GMImage.MontageGeometry](GMImageMontageGeometry.md)

[HTML Version](GMImageModulate.shtml)