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


Compares current image with another image.

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


Parameter Description Example
ImageRef The image reference number. 1
OtherImageRef The image reference number. 1


Returns true if equal and false if not equal.


Compares current image with another image.
Sets meanErrorPerPixel, normalizedMaxError, and normalizedMeanError in the current image. False is returned if the images are identical.


Compare images:

Set Variable [$img1; Value:MBS( "GMImage.NewFromContainer"; test::Container1 )]
Set Variable [$img2; Value:MBS( "GMImage.NewFromContainer"; test::Container2 )]
Set Variable [$result; Value:MBS( "GMImage.Compare"; $img1; $img2 )]
If [$result = 1]
    Show Custom Dialog ["Image Comparison"; "equal"]
Else If [$result = 0]
    Set Variable [$e; Value:MBS( "GMImage.NormalizedMaxError"; $img1 )]
    If [$e ≠ 0 and $e < ,03]
        Show Custom Dialog ["Image Comparison"; "very similar: " & MBS( "GMImage.NormalizedMaxError"; $img1 )]
        Show Custom Dialog ["Image Comparison"; "not equal"]
    End If
End If
Set Variable [$r; Value:MBS("GMImage.Release"; $img1)]
Set Variable [$r; Value:MBS("GMImage.Release"; $img2)]

See also

This function checks for a license.

Created 18th August 2014, last changed 21st December 2018

GMImage.Columns - GMImage.Composite