granicus.if.org Git - imagemagick/blob - www/api/annotate.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Annotate an Image</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, annotate, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  17   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 127 </div>
 128 <div  class="sponsor">
 129    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
 142 </div>
 143 </div>
 144 </div>
 145 \r
 146 \r
 147 </div>\r
 148 \r
 149 <div class="main">\r
 150 \r
 151 <p class="navigation-index">[<a href="#AnnotateImage">AnnotateImage</a> &bull; <a href="#FormatMagickCaption">FormatMagickCaption</a> &bull; <a href="#GetMultilineTypeMetrics">GetMultilineTypeMetrics</a> &bull; <a href="#GetTypeMetrics">GetTypeMetrics</a>]</p>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 154 _8c.html" target="source" name="AnnotateImage">AnnotateImage</a></h2>
 155 <div class="doc-section">
 156
 157 <p>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:</p>
 158
 159 <pre class="text">
 160       b   file size in bytes.
 161       c   comment.
 162       d   directory in which the image resides.
 163       e   extension of the image file.
 164       f   original filename of the image.
 165       h   height of image.
 166       i   filename of the image.
 167       k   number of unique colors.
 168       l   image label.
 169       m   image file format.
 170       n   number of images in a image sequence.
 171       o   output image filename.
 172       p   page number of the image.
 173       q   image depth (8 or 16).
 174       q   image depth (8 or 16).
 175       s   image scene number.
 176       t   image filename without any extension.
 177       u   a unique temporary filename.
 178       w   image width.
 179       x   x resolution of the image.
 180       y   y resolution of the image.
 181 </pre>
 182
 183 <p>The format of the AnnotateImage method is:</p>
 184
 185 <pre class="code">
 186   MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
 187 </pre>
 188
 189 <p>A description of each parameter follows:</p></ol>
 190
 191 <h5>image</h5>
 192 <ol><p>the image.</p></ol>
 193
 194 <h5>draw_info</h5>
 195 <ol><p>the draw info.</p></ol>
 196
 197  </div>
 198 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 199 _8c.html" target="source" name="FormatMagickCaption">FormatMagickCaption</a></h2>
 200 <div class="doc-section">
 201
 202 <p>FormatMagickCaption() formats a caption so that it fits within the image width.  It returns the number of lines in the formatted caption.</p></ol>
 203
 204 <p>The format of the FormatMagickCaption method is:</p>
 205
 206 <pre class="code">
 207   long FormatMagickCaption(Image *image,DrawInfo *draw_info,
 208     TypeMetric *metrics,char **caption)
 209 </pre>
 210
 211 <p>A description of each parameter follows.</p></ol>
 212
 213 <h5>image</h5>
 214 <ol><p>The image.</p></ol>
 215
 216 <h5>caption</h5>
 217 <ol><p>the caption.</p></ol>
 218
 219 <h5>draw_info</h5>
 220 <ol><p>the draw info.</p></ol>
 221
 222 <h5>metrics</h5>
 223 <ol><p>Return the font metrics in this structure.</p></ol>
 224
 225  </div>
 226 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 227 _8c.html" target="source" name="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
 228 <div class="doc-section">
 229
 230 <p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
 231
 232 <pre class="text">
 233       character width
 234       character height
 235       ascender
 236       descender
 237       text width
 238       text height
 239       maximum horizontal advance
 240       bounds: x1
 241       bounds: y1
 242       bounds: x2
 243       bounds: y2
 244       origin: x
 245       origin: y
 246       underline position
 247       underline thickness
 248 </pre>
 249
 250 <p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
 251
 252 <p>The format of the GetMultilineTypeMetrics method is:</p>
 253
 254 <pre class="code">
 255   MagickBooleanType GetMultilineTypeMetrics(Image *image,
 256     const DrawInfo *draw_info,TypeMetric *metrics)
 257 </pre>
 258
 259 <p>A description of each parameter follows:</p></ol>
 260
 261 <h5>image</h5>
 262 <ol><p>the image.</p></ol>
 263
 264 <h5>draw_info</h5>
 265 <ol><p>the draw info.</p></ol>
 266
 267 <h5>metrics</h5>
 268 <ol><p>Return the font metrics in this structure.</p></ol>
 269
 270  </div>
 271 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 272 _8c.html" target="source" name="GetTypeMetrics">GetTypeMetrics</a></h2>
 273 <div class="doc-section">
 274
 275 <p>GetTypeMetrics() returns the following information for the specified font and text:</p>
 276
 277 <pre class="text">
 278       character width
 279       character height
 280       ascender
 281       descender
 282       text width
 283       text height
 284       maximum horizontal advance
 285       bounds: x1
 286       bounds: y1
 287       bounds: x2
 288       bounds: y2
 289       origin: x
 290       origin: y
 291       underline position
 292       underline thickness
 293 </pre>
 294
 295 <p>The format of the GetTypeMetrics method is:</p>
 296
 297 <pre class="code">
 298   MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
 299     TypeMetric *metrics)
 300 </pre>
 301
 302 <p>A description of each parameter follows:</p></ol>
 303
 304 <h5>image</h5>
 305 <ol><p>the image.</p></ol>
 306
 307 <h5>draw_info</h5>
 308 <ol><p>the draw info.</p></ol>
 309
 310 <h5>metrics</h5>
 311 <ol><p>Return the font metrics in this structure.</p></ol>
 312
 313  </div>
 314 \r
 315 </div>\r
 316 \r
 317 <div id="linkbar">\r
 318  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 319     <span id="linkbar-center">\r
 320       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 321       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 322     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 323     </span>\r
 324     <span id="linkbar-east">&nbsp;</span>\r
 325   </div>\r
 326   <div class="footer">\r
 327     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 328     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 329   </div>\r
 330   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 331 </body>\r
 332 </html>\r