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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  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="Application-name" content="ImageMagick"/>
  16   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <meta name="Generator" content="PHP"/>
  19   <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"/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28   <link rel="icon" href="../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <div style="margin: 17px auto; float: left;">\r
  53   <script type="text/javascript">\r
  54   <!--\r
  55     google_ad_client = "pub-3129977114552745";\r
  56     google_ad_slot = "5439289906";\r
  57     google_ad_width = 728;\r
  58     google_ad_height = 90;\r
  59   //-->\r
  60   </script>\r
  61   <script type="text/javascript"\r
  62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  63   </script>\r
  64 </div>\r
  65 <a href="http://www.imagemagick.org/discourse-server/">\r
  66   <img src="../../images/logo.jpg"\r
  67   alt="ImageMagick Logo"\r
  68   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  69 <a href="../../index.html">\r
  70   <img src="../../images/sprite.jpg"\r
  71   alt="ImageMagick Sprite"\r
  72   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  73 </div>\r
  74 \r
  75 <div class="westbar">\r
  76 \r
  77 <div class="menu">
  78   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  95 </div>
  96 <div class="sep"></div>\r
  97 <div class="menu">
  98   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 108 </div>
 109 <div class="menu">
 110   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 117 </div>
 118 <div class="sub">
 119     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 133  </div>
 134 <div class="menu">
 135   <a title="Resources" href="../../www/resources.html">Resources</a>
 136 </div>
 137 <div class="menu">
 138   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 139 </div>
 140 <div class="menu">
 141   <a title="Download" href="../../www/download.html">Download</a>
 142 </div>
 143 <div class="sep"></div>\r
 144 <div class="menu">
 145   <a title="Search" href="../../www/search.html">Search</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div class="menu">
 149   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 150 </div>
 151 <div  class="sub">
 152   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 153 </div>
 154 <div class="sep"></div>\r
 155 <div  class="menu">
 156   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 157
 158 <a href="http://www.networkredux.com">
 159   <img src="../../images/networkredux.png" alt="[sponsor]"
 160   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 161 <div class="sponsbox">
 162 <div  class="sponsor">
 163   <a title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 164 </div>
 165 <div  class="sponsor">
 166   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 167 </div>
 168 <div  class="sponsor">
 169   <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 170 </div>
 171 <div  class="sponsor">
 172   <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201107010090 alexanian media -->
 173 </div>
 174 <div  class="sponsor">
 175   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 176 </div>
 177 <div  class="sponsor">
 178   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 179 </div>
 180 <div  class="sponsor">
 181   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 182 </div>
 183 <div  class="sponsor">
 184   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 185 </div>
 186 <div  class="sponsor">
 187    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 188 </div>
 189 </div>
 190 </div>
 191 </div>\r
 192 \r
 193 <div class="eastbar">\r
 194 \r
 195 </div>\r
 196 \r
 197 <div class="main">\r
 198 \r
 199 <h1>Module annotate Methods</h1>
 200 <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>
 201
 202 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="AnnotateImage">AnnotateImage</a></h2>
 203 <div class="doc-section">
 204
 205 <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>
 206
 207 <pre class="text">
 208       b   file size in bytes.
 209       c   comment.
 210       d   directory in which the image resides.
 211       e   extension of the image file.
 212       f   original filename of the image.
 213       h   height of image.
 214       i   filename of the image.
 215       k   number of unique colors.
 216       l   image label.
 217       m   image file format.
 218       n   number of images in a image sequence.
 219       o   output image filename.
 220       p   page number of the image.
 221       q   image depth (8 or 16).
 222       q   image depth (8 or 16).
 223       s   image scene number.
 224       t   image filename without any extension.
 225       u   a unique temporary filename.
 226       w   image width.
 227       x   x resolution of the image.
 228       y   y resolution of the image.
 229 </pre>
 230
 231 <p>The format of the AnnotateImage method is:</p>
 232
 233 <pre class="code">
 234   MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
 235 </pre>
 236
 237 <p>A description of each parameter follows:</p>
 238
 239 <h5>image</h5>
 240 <p>the image.</p>
 241
 242 <h5>draw_info</h5>
 243 <p>the draw info.</p>
 244
 245  </div>
 246 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="FormatMagickCaption">FormatMagickCaption</a></h2>
 247 <div class="doc-section">
 248
 249 <p>FormatMagickCaption() formats a caption so that it fits within the image width.  It returns the number of lines in the formatted caption.</p>
 250
 251 <p>The format of the FormatMagickCaption method is:</p>
 252
 253 <pre class="code">
 254   ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
 255     const MagickBooleanType split,TypeMetric *metrics,char **caption)
 256 </pre>
 257
 258 <p>A description of each parameter follows.</p>
 259
 260 <h5>image</h5>
 261 <p>The image.</p>
 262
 263 <h5>draw_info</h5>
 264 <p>the draw info.</p>
 265
 266 <h5>split</h5>
 267 <p>when no convenient line breaks-- insert newline.</p>
 268
 269 <h5>metrics</h5>
 270 <p>Return the font metrics in this structure.</p>
 271
 272 <h5>caption</h5>
 273 <p>the caption.</p>
 274
 275  </div>
 276 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
 277 <div class="doc-section">
 278
 279 <p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
 280
 281 <pre class="text">
 282       character width
 283       character height
 284       ascender
 285       descender
 286       text width
 287       text height
 288       maximum horizontal advance
 289       bounds: x1
 290       bounds: y1
 291       bounds: x2
 292       bounds: y2
 293       origin: x
 294       origin: y
 295       underline position
 296       underline thickness
 297 </pre>
 298
 299 <p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
 300
 301 <p>The format of the GetMultilineTypeMetrics method is:</p>
 302
 303 <pre class="code">
 304   MagickBooleanType GetMultilineTypeMetrics(Image *image,
 305     const DrawInfo *draw_info,TypeMetric *metrics)
 306 </pre>
 307
 308 <p>A description of each parameter follows:</p>
 309
 310 <h5>image</h5>
 311 <p>the image.</p>
 312
 313 <h5>draw_info</h5>
 314 <p>the draw info.</p>
 315
 316 <h5>metrics</h5>
 317 <p>Return the font metrics in this structure.</p>
 318
 319  </div>
 320 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="GetTypeMetrics">GetTypeMetrics</a></h2>
 321 <div class="doc-section">
 322
 323 <p>GetTypeMetrics() returns the following information for the specified font and text:</p>
 324
 325 <pre class="text">
 326       character width
 327       character height
 328       ascender
 329       descender
 330       text width
 331       text height
 332       maximum horizontal advance
 333       bounds: x1
 334       bounds: y1
 335       bounds: x2
 336       bounds: y2
 337       origin: x
 338       origin: y
 339       underline position
 340       underline thickness
 341 </pre>
 342
 343 <p>The format of the GetTypeMetrics method is:</p>
 344
 345 <pre class="code">
 346   MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
 347     TypeMetric *metrics)
 348 </pre>
 349
 350 <p>A description of each parameter follows:</p>
 351
 352 <h5>image</h5>
 353 <p>the image.</p>
 354
 355 <h5>draw_info</h5>
 356 <p>the draw info.</p>
 357
 358 <h5>metrics</h5>
 359 <p>Return the font metrics in this structure.</p>
 360
 361  </div>
 362 \r
 363 </div>\r
 364 \r
 365 <div id="linkbar">\r
 366     <span id="linkbar-west">&nbsp;</span>\r
 367     <span id="linkbar-center">\r
 368       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 369       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 370     </span>\r
 371     <span id="linkbar-east">&nbsp;</span>\r
 372   </div>\r
 373   <div class="footer">\r
 374     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 375     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 376   </div>\r
 377   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 378   <script type="text/javascript">\r
 379     var _gaq = _gaq || [];\r
 380     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 381     _gaq.push(['_trackPageview']);\r
 382 \r
 383     (function() {\r
 384       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 385       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 386       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 387     })();\r
 388   </script>\r
 389 </body>\r
 390 </html>\r