GMImage.Transparent
-------------------

Add matte image to image, setting pixels matching color to transparent

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

MBS( "GMImage.Transparent"; ImageRef; Color ) 

**MBS**( **"GMImage.Transparent";** /\* Add matte image to image, setting pixels matching color to transparent \*/  
**$ImageRef**; /\* The image reference number.e.g. 1 \*/   
**$Color**) /\* A color value.   
This can be a string in the following format "HSL h s l a", "YUV y u v a", "RGB r g b a", "MONO m a", "GRAY g a" or "COLOR R G B a". Alpha value a is optional. Range of values is 0 to 1.0 except if you use COLOR where RGB values are 0 to 65535.  
Starting with version 5.4 of our plugin, you can use hex notation. # followed by 2 digits for red, green, blue and optional alpha, e.g. #FF0000 for full red.e.g. "RGB 1 0 0" \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| ImageRef | The image reference number. | 1 |
| Color | A color value.    This can be a string in the following format "HSL h s l a", "YUV y u v a", "RGB r g b a", "MONO m a", "GRAY g a" or "COLOR R G B a". Alpha value a is optional. Range of values is 0 to 1.0 except if you use COLOR where RGB values are 0 to 65535.   Starting with version 5.4 of our plugin, you can use hex notation. # followed by 2 digits for red, green, blue and optional alpha, e.g. #FF0000 for full red. | "RGB 1 0 0" |

### Result

Returns "OK" on success.

### Description

Add matte image to image, setting pixels matching color to transparent  
### Examples

Make a picture transparent:

 #load a picture   
Set Variable \[$image ; Value:MBS ( "[GMImage.NewFromContainer](GMImageNewFromContainer.md)"; Test::BigImage )\]  
\#white in RGB   
Set Variable \[$f ; Value:"COLOR 65535 65535 65535"\]  
\#Replace all white with nearly white   
Set Variable \[$r ; Value:MBS ( "[GMImage.ReplaceColor](GMImageReplaceColor.md)"; $image ; $f ; "COLOR 65535 65278 65535"; 0)\]  
\#now flood fill it with 5 as tolerance   
Set Variable \[$r ; Value:MBS ( "[GMImage.SetColorFuzz](GMImageSetColorFuzz.md)"; $image ; 5 )\]  
Set Variable \[$r ; Value:MBS ( "[GMImage.FloodFillColorXY](GMImageFloodFillColorXY.md)"; $image ; 0; 0; $f )\]  
\#now set back fuzz and make transparent using white   
Set Variable \[$r ; Value:MBS ( "[GMImage.SetColorFuzz](GMImageSetColorFuzz.md)"; $image ; 0 )\]  
Set Variable \[$imagecolor ; Value:MBS ( "GMImage.Transparent"; $image ; $f )\]  
\#write back to container   
Set Field \[Test::Result ; MBS ( "[GMImage.WriteToPNGContainer](GMImageWriteToPNGContainer.md)"; $image ;)\]  
\#cleanup   
Set Variable \[$Error ; Value:MBS ("[GMImage.Release](GMImageRelease.md)";$image )\]  
### See also

- [GMImage.FloodFillColor](GMImageFloodFillColor.md)
- [GMImage.FloodFillColorXY](GMImageFloodFillColorXY.md)
- [GMImage.NewFromContainer](GMImageNewFromContainer.md)
- [GMImage.Release](GMImageRelease.md)
- [GMImage.ReplaceColor](GMImageReplaceColor.md)
- [GMImage.SetColorFuzz](GMImageSetColorFuzz.md)
- [GMImage.Threshold](GMImageThreshold.md)
- [GMImage.Transform](GMImageTransform.md)
- [GMImage.Translation](GMImageTranslation.md)
- [GMImage.WriteToPNGContainer](GMImageWriteToPNGContainer.md)

This function checks for a license.

Created 18th August 2014 , last changed 11st November 2019

  
[GMImage.Translation](GMImageTranslation.md) - [GMImage.Trim](GMImageTrim.md)

[HTML Version](GMImageTransparent.shtml)