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