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" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   7   <title>ImageMagick: MagickCore, C API for ImageMagick: Annotate an Image</title/>
   8   <meta http-equiv="Content-Language" content="en-US"/>
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <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."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  14   <meta name="Generator" content="PHP"/>
  15   <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"/>
  16   <meta name="Rating" content="GENERAL"/>
  17   <meta name="Robots" content="INDEX, FOLLOW"/>
  18   <meta name="Generator" content="ImageMagick Studio LLC"/>
  19   <meta name="Author" content="ImageMagick Studio LLC"/>
  20   <meta name="Revisit-after" content="2 DAYS"/>
  21   <meta name="Resource-type" content="document"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
  25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../../index.html">\r
  35   <img src="../../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../../index.html">\r
  44   <img src="../../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  62 </div>
  63 <div class="sub">
  64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130    <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 143 </div>
 144 <div  class="sponsor">
 145   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 146 </div>
 147 <div  class="sponsor">
 148   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 149 </div>
 150 <div  class="sponsor">
 151    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 152 </div>
 153 </div>
 154 </div>
 155 </div>\r
 156 \r
 157 <div class="eastbar">\r
 158   <script type="text/javascript">\r
 159   <!--\r
 160     google_ad_client = "pub-3129977114552745";\r
 161     google_ad_slot = "0574824969";\r
 162     google_ad_width = 160;\r
 163     google_ad_height = 600;\r
 164   //-->\r
 165   </script>\r
 166   <script type="text/javascript"\r
 167     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 168   </script>\r
 169 </div>\r
 170 \r
 171 <div class="main">\r
 172 \r
 173 <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>
 174
 175 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 176 _8c.html" target="source" name="AnnotateImage">AnnotateImage</a></h2>
 177 <div class="doc-section">
 178
 179 <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>
 180
 181 <pre class="text">
 182       b   file size in bytes.
 183       c   comment.
 184       d   directory in which the image resides.
 185       e   extension of the image file.
 186       f   original filename of the image.
 187       h   height of image.
 188       i   filename of the image.
 189       k   number of unique colors.
 190       l   image label.
 191       m   image file format.
 192       n   number of images in a image sequence.
 193       o   output image filename.
 194       p   page number of the image.
 195       q   image depth (8 or 16).
 196       q   image depth (8 or 16).
 197       s   image scene number.
 198       t   image filename without any extension.
 199       u   a unique temporary filename.
 200       w   image width.
 201       x   x resolution of the image.
 202       y   y resolution of the image.
 203 </pre>
 204
 205 <p>The format of the AnnotateImage method is:</p>
 206
 207 <pre class="code">
 208   MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
 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>draw_info</h5>
 217 <ol><p>the draw info.</p></ol>
 218
 219  </div>
 220 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 221 _8c.html" target="source" name="FormatMagickCaption">FormatMagickCaption</a></h2>
 222 <div class="doc-section">
 223
 224 <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>
 225
 226 <p>The format of the FormatMagickCaption method is:</p>
 227
 228 <pre class="code">
 229   ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
 230     const MagickBooleanType split,TypeMetric *metrics,char **caption)
 231 </pre>
 232
 233 <p>A description of each parameter follows.</p></ol>
 234
 235 <h5>image</h5>
 236 <ol><p>The image.</p></ol>
 237
 238 <h5>draw_info</h5>
 239 <ol><p>the draw info.</p></ol>
 240
 241 <h5>split</h5>
 242 <ol><p>when no convenient line breaks-- insert newline.</p></ol>
 243
 244 <h5>metrics</h5>
 245 <ol><p>Return the font metrics in this structure.</p></ol>
 246
 247 <h5>caption</h5>
 248 <ol><p>the caption.</p></ol>
 249
 250  </div>
 251 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 252 _8c.html" target="source" name="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
 253 <div class="doc-section">
 254
 255 <p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
 256
 257 <pre class="text">
 258       character width
 259       character height
 260       ascender
 261       descender
 262       text width
 263       text height
 264       maximum horizontal advance
 265       bounds: x1
 266       bounds: y1
 267       bounds: x2
 268       bounds: y2
 269       origin: x
 270       origin: y
 271       underline position
 272       underline thickness
 273 </pre>
 274
 275 <p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
 276
 277 <p>The format of the GetMultilineTypeMetrics method is:</p>
 278
 279 <pre class="code">
 280   MagickBooleanType GetMultilineTypeMetrics(Image *image,
 281     const DrawInfo *draw_info,TypeMetric *metrics)
 282 </pre>
 283
 284 <p>A description of each parameter follows:</p></ol>
 285
 286 <h5>image</h5>
 287 <ol><p>the image.</p></ol>
 288
 289 <h5>draw_info</h5>
 290 <ol><p>the draw info.</p></ol>
 291
 292 <h5>metrics</h5>
 293 <ol><p>Return the font metrics in this structure.</p></ol>
 294
 295  </div>
 296 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 297 _8c.html" target="source" name="GetTypeMetrics">GetTypeMetrics</a></h2>
 298 <div class="doc-section">
 299
 300 <p>GetTypeMetrics() returns the following information for the specified font and text:</p>
 301
 302 <pre class="text">
 303       character width
 304       character height
 305       ascender
 306       descender
 307       text width
 308       text height
 309       maximum horizontal advance
 310       bounds: x1
 311       bounds: y1
 312       bounds: x2
 313       bounds: y2
 314       origin: x
 315       origin: y
 316       underline position
 317       underline thickness
 318 </pre>
 319
 320 <p>The format of the GetTypeMetrics method is:</p>
 321
 322 <pre class="code">
 323   MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
 324     TypeMetric *metrics)
 325 </pre>
 326
 327 <p>A description of each parameter follows:</p></ol>
 328
 329 <h5>image</h5>
 330 <ol><p>the image.</p></ol>
 331
 332 <h5>draw_info</h5>
 333 <ol><p>the draw info.</p></ol>
 334
 335 <h5>metrics</h5>
 336 <ol><p>Return the font metrics in this structure.</p></ol>
 337
 338  </div>
 339 \r
 340 </div>\r
 341 \r
 342 <div id="linkbar">\r
 343     <span id="linkbar-west">&nbsp;</span>\r
 344     <span id="linkbar-center">\r
 345       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 346       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 347     </span>\r
 348     <span id="linkbar-east">&nbsp;</span>\r
 349   </div>\r
 350   <div class="footer">\r
 351     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 352     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 353   </div>\r
 354   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 355   <script type="text/javascript">\r
 356     var _gaq = _gaq || [];\r
 357     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 358     _gaq.push(['_trackPageview']);\r
 359 \r
 360     (function() {\r
 361       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 362       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 363       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 364     })();\r
 365   </script>\r
 366 </body>\r
 367 </html>\r