Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

GMImage.Colorize

Colorize image with pen color, using specified percent opacity.

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

Parameters

Parameter Description Example
ImageRef The image reference number. 1
opacity Percent from 0 to 100. 50
penColor 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

Colorize image with pen color, using specified percent opacity.
Blends the fill color with each pixel in the image.
A percentage blend is specified with opacity. Control the application of different color components by specifying a different percentage for each component (e.g. 90/100/10 is 90% red, 100% green, and 10% blue).

Examples

Colorize an image:

Set Variable [ $image ; Value: MBS( "GMImage.NewFromContainer"; test::Input ) ]
Set Variable [ $r ; Value: MBS( "GMImage.Colorize"; $image; 50; "RGB 1 0 0" ) ]
Set Field [ test::Output ; MBS( "GMImage.WriteToPNGContainer"; $image) ]
Set Variable [ $r ; Value: MBS( "GMImage.Release"; $image) ]

See also

This function checks for a license.

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


GMImage.Coders - GMImage.ColorizeRGB