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: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 146 </div>
 147 </div>
 148 </div>
 149 </div>\r
 150 \r
 151 <div class="eastbar">\r
 152   <script type="text/javascript">\r
 153   <!--\r
 154     google_ad_client = "pub-3129977114552745";\r
 155     google_ad_slot = "0574824969";\r
 156     google_ad_width = 160;\r
 157     google_ad_height = 600;\r
 158   //-->\r
 159   </script>\r
 160   <script type="text/javascript"\r
 161     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 162   </script>\r
 163 </div>\r
 164 \r
 165 <div class="main">\r
 166 \r
 167 <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>
 168
 169 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 170 _8c.html" target="source" name="AnnotateImage">AnnotateImage</a></h2>
 171 <div class="doc-section">
 172
 173 <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>
 174
 175 <pre class="text">
 176       b   file size in bytes.
 177       c   comment.
 178       d   directory in which the image resides.
 179       e   extension of the image file.
 180       f   original filename of the image.
 181       h   height of image.
 182       i   filename of the image.
 183       k   number of unique colors.
 184       l   image label.
 185       m   image file format.
 186       n   number of images in a image sequence.
 187       o   output image filename.
 188       p   page number of the image.
 189       q   image depth (8 or 16).
 190       q   image depth (8 or 16).
 191       s   image scene number.
 192       t   image filename without any extension.
 193       u   a unique temporary filename.
 194       w   image width.
 195       x   x resolution of the image.
 196       y   y resolution of the image.
 197 </pre>
 198
 199 <p>The format of the AnnotateImage method is:</p>
 200
 201 <pre class="code">
 202   MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
 203 </pre>
 204
 205 <p>A description of each parameter follows:</p></ol>
 206
 207 <h5>image</h5>
 208 <ol><p>the image.</p></ol>
 209
 210 <h5>draw_info</h5>
 211 <ol><p>the draw info.</p></ol>
 212
 213  </div>
 214 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 215 _8c.html" target="source" name="FormatMagickCaption">FormatMagickCaption</a></h2>
 216 <div class="doc-section">
 217
 218 <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>
 219
 220 <p>The format of the FormatMagickCaption method is:</p>
 221
 222 <pre class="code">
 223   ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
 224     TypeMetric *metrics,char **caption)
 225 </pre>
 226
 227 <p>A description of each parameter follows.</p></ol>
 228
 229 <h5>image</h5>
 230 <ol><p>The image.</p></ol>
 231
 232 <h5>caption</h5>
 233 <ol><p>the caption.</p></ol>
 234
 235 <h5>draw_info</h5>
 236 <ol><p>the draw info.</p></ol>
 237
 238 <h5>metrics</h5>
 239 <ol><p>Return the font metrics in this structure.</p></ol>
 240
 241  </div>
 242 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 243 _8c.html" target="source" name="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
 244 <div class="doc-section">
 245
 246 <p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
 247
 248 <pre class="text">
 249       character width
 250       character height
 251       ascender
 252       descender
 253       text width
 254       text height
 255       maximum horizontal advance
 256       bounds: x1
 257       bounds: y1
 258       bounds: x2
 259       bounds: y2
 260       origin: x
 261       origin: y
 262       underline position
 263       underline thickness
 264 </pre>
 265
 266 <p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
 267
 268 <p>The format of the GetMultilineTypeMetrics method is:</p>
 269
 270 <pre class="code">
 271   MagickBooleanType GetMultilineTypeMetrics(Image *image,
 272     const DrawInfo *draw_info,TypeMetric *metrics)
 273 </pre>
 274
 275 <p>A description of each parameter follows:</p></ol>
 276
 277 <h5>image</h5>
 278 <ol><p>the image.</p></ol>
 279
 280 <h5>draw_info</h5>
 281 <ol><p>the draw info.</p></ol>
 282
 283 <h5>metrics</h5>
 284 <ol><p>Return the font metrics in this structure.</p></ol>
 285
 286  </div>
 287 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 288 _8c.html" target="source" name="GetTypeMetrics">GetTypeMetrics</a></h2>
 289 <div class="doc-section">
 290
 291 <p>GetTypeMetrics() returns the following information for the specified font and text:</p>
 292
 293 <pre class="text">
 294       character width
 295       character height
 296       ascender
 297       descender
 298       text width
 299       text height
 300       maximum horizontal advance
 301       bounds: x1
 302       bounds: y1
 303       bounds: x2
 304       bounds: y2
 305       origin: x
 306       origin: y
 307       underline position
 308       underline thickness
 309 </pre>
 310
 311 <p>The format of the GetTypeMetrics method is:</p>
 312
 313 <pre class="code">
 314   MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
 315     TypeMetric *metrics)
 316 </pre>
 317
 318 <p>A description of each parameter follows:</p></ol>
 319
 320 <h5>image</h5>
 321 <ol><p>the image.</p></ol>
 322
 323 <h5>draw_info</h5>
 324 <ol><p>the draw info.</p></ol>
 325
 326 <h5>metrics</h5>
 327 <ol><p>Return the font metrics in this structure.</p></ol>
 328
 329  </div>
 330 \r
 331 </div>\r
 332 \r
 333 <div id="linkbar">\r
 334     <span id="linkbar-west">&nbsp;</span>\r
 335     <span id="linkbar-center">\r
 336       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 337       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 338     </span>\r
 339     <span id="linkbar-east">&nbsp;</span>\r
 340   </div>\r
 341   <div class="footer">\r
 342     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 343     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 344   </div>\r
 345   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 346   <script type="text/javascript">\r
 347     var _gaq = _gaq || [];\r
 348     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 349     _gaq.push(['_trackPageview']);\r
 350 \r
 351     (function() {\r
 352       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 353       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 354       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 355     })();\r
 356   </script>\r
 357 </body>\r
 358 </html>\r