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

GMImage.Describe

Describes an image by printing its attributes.

Component Version macOS Windows Linux Server iOS SDK
GraphicsMagick 13.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "GMImage.Describe"; ImageRef; verbose )   More

Parameters

Parameter Description Example
ImageRef The image reference number. 1
verbose Whether output should be verbose.
Default is 1. Pass 0 to get a shorted output.
Pass 2 to count the number of colors in the image.
1

Result

Returns OK or error.

Description

Describes an image by printing its attributes.
Attributes include the image width, height, size, and others.

Examples

Describe a picture from container:

# Load from container
Set Variable [ $BigImageRef ; Value: MBS("GMImage.NewFromContainer"; Test::BigImage) ]
# put description into text field
Set Variable [ $Result ; Value: MBS("GMImage.Describe"; $BigImageRef) ]
Set Field [ Test::Result ; $Result ]
Set Variable [ $Error ; Value: MBS("GMImage.Free";$BigImageRef) ]

See also

Release notes

Blog Entries

This function checks for a license.

Created 19th May 2023, last changed 27th August 2023


GMImage.CycleColormap - GMImage.Despeckle