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: 12.1   12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3   13.4    Statistic    FMM    Blog  

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

💬 Ask a question or report a problem