Skip to page contents

[ About ImageMagick ]
[ Command-line Tools Processing Options Usage Program Interfaces MagickWand MagickCore PerlMagick Magick++ Architecture ]
[ Install from Source Unix Windows Binary Releases Unix Mac OS X Windows Resources ]
[ Download ]
[ Site Map Links ]
[ Sponsors:

oahu Real Estate
Software Download
Posters

]

[ AnnotateImage | FormatMagickCaption | GetMultilineTypeMetrics | GetTypeMetrics ]

AnnotateImage() annotates an image with text. Optionally you can include any of the following bits of information about the image by embedding the appropriate special characters:

      b   file size in bytes.
      c   comment.
      d   directory in which the image resides.
      e   extension of the image file.
      f   original filename of the image.
      h   height of image.
      i   filename of the image.
      k   number of unique colors.
      l   image label.
      m   image file format.
      n   number of images in a image sequence.
      o   output image filename.
      p   page number of the image.
      q   image depth (8 or 16).
      p   page number of the image.
      q   image depth (8 or 16).
      s   image scene number.
      t   image filename without any extension.
      u   a unique temporary filename.
      w   image width.
      x   x resolution of the image.
      y   y resolution of the image.

The format of the AnnotateImage method is:

  MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)

A description of each parameter follows:

image

the image.

draw_info

the draw info.

FormatMagickCaption() formats a caption so that it fits within the image width. It returns the number of lines in the formatted caption.

The format of the FormatMagickCaption method is:

  long FormatMagickCaption(Image *image,DrawInfo *draw_info,char *caption,
    TypeMetric *metrics)

A description of each parameter follows.

image

The image.

draw_info

the draw info.

metrics

Return the font metrics in this structure.

GetMultilineTypeMetrics() returns the following information for the specified font and text:

      character width
      character height
      ascent
      descent
      text width
      text height
      maximum horizontal advance
      underline position
      underline thickness

This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.

The format of the GetMultilineTypeMetrics method is:

  MagickBooleanType GetMultilineTypeMetrics(Image *image,
    const DrawInfo *draw_info,TypeMetric *metrics)

A description of each parameter follows:

image

the image.

draw_info

the draw info.

metrics

Return the font metrics in this structure.

GetTypeMetrics() returns the following information for the specified font and text:

      character width
      character height
      ascent
      descent
      text width
      text height
      maximum horizontal advance
      underline position
      underline thickness

The format of the GetTypeMetrics method is:

  MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
    TypeMetric *metrics)

A description of each parameter follows:

image

the image.

draw_info

the draw info.

metrics

Return the font metrics in this structure.