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

GMImage.SetBorderColor

Sets the Image border color.

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

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

Sets the Image border color.
You can set this and call GMImage.Border to add border with given color.

Examples

Add whitespace on top and bottom of image:

Let ( [

$Image = MBS("GMImage.NewFromContainer"; GraphicsMagick::image);
$r = MBS( "GMImage.SetBorderColor"; $Image; "white" );
$r = MBS("GMImage.Border";$Image; "0x100");
$Result = MBS("GMImage.WriteToPNGContainer"; $Image);

$r = MBS("GMImage.Release";$Image)
];

$Result)

See also

Blog Entries

This function checks for a license.

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


GMImage.SetBackgroundTexture - GMImage.SetBoxColor