Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 10.0   10.1   10.2   10.3   10.4   10.5   11.0   11.1   11.2   11.3    Statistic    FMM    Blog  


Calculates the average pixel value.

Component Version macOS Windows Linux Server iOS SDK
GraphicsMagick 3.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "GMImage.AveragePixelValue"; ImageRef { ; X; Y; Width; Height } )   More


Parameter Description Example Flags
ImageRef The image reference number. 1
X X-Position of the rectangle. $left Optional
Y Y-Position of the rectangle. $top Optional
Width The width of the rectangle.
Default is width of image.
$width Optional
Height The height of the rectangle.
Default is height of image.
$height Optional


Returns the average pixel value.


Calculates the average pixel value.
Value is in range from 0.0 to 1.0 depending if it is more black (0.0) or white (1.0).
Make sure the pixels are in RGB format before you call this method. (Use GMImage.SetType with value 6.)
This function is designed to test if a certain area in the image is white or black.
Does not check alpha channel!

Version 9.1 and later uses full image if rectangle is missed.

See also

Release notes

Example Databases

Blog Entries

Created 18th August 2014, last changed 18th February 2019

GMImage.AutoOrient - GMImage.BaseColumns

Feedback: Report problem or ask question.

MBS Xojo Plugins

Start Chat