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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html version="-//W3C//DTD XHTML 1.1//EN"
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   8 <head>
   9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
  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 automagically."/>
  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, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  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-2012 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="canonical" href="http://www.imagemagick.org" />
  31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  32   <!-- Add jQuery library -->
  33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  34
  35   <!-- Optionaly include easing and/or mousewheel plugins -->
  36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
  38
  39   <!-- Add fancyBox -->
  40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
  42
  43   <!-- Optionaly include button and/or thumbnail helpers -->
  44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
  45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
  46
  47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
  48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
  49   <script type="text/javascript">
  50         $(document).ready(function() {
  51                 $(".fancybox").fancybox();
  52         });
  53   </script>
  54   <!-- ImageMagick style -->
  55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
  56   <style type="text/css" media="all">
  57     @import url("../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick.css");
  58   </style>
  59 </head>
  60
  61 <body id="www-imagemagick-org">
  62 <div class="titlebar">
  63 <div style="margin: 17px auto; float: left;">
  64   <script type="text/javascript">
  65   <!--
  66     google_ad_client = "pub-3129977114552745";
  67     google_ad_slot = "5439289906";
  68     google_ad_width = 728;
  69     google_ad_height = 90;
  70   //-->
  71   </script>
  72   <script type="text/javascript"
  73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  74   </script>
  75 </div>
  76 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">
  77   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/logo.jpg"
  78   alt="ImageMagick Logo"
  79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  80 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">
  81   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/sprite.jpg"
  82   alt="ImageMagick Sprite"
  83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  84 </div>
  85
  86 <div class="westbar">
  87
  88 <div class="menu">
  89   <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
  90 </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
 105 </div>
 106 <div class="sep"></div>
 107 <div class="menu">
 108   <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
 112 </div>
 113 <div class="sub">
 114     <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 118 </div>
 119 <div class="menu">
 120   <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
 121 </div>
 122 <div class="sub">
 123     <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
 124 </div>
 125 <div class="sub">
 126     <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
 133 </div>
 134 <div class="sep"></div>
 135 <div  class="menu">
 136    <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
 137 </div>
 138 <div class="sub">
 139     <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
 140 </div>
 141 <div class="sub">
 142     <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
 143  </div>
 144 <div class="menu">
 145   <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
 146 </div>
 147 <div class="menu">
 148   <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
 149 </div>
 150 <div class="menu">
 151   <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
 152 </div>
 153 <div class="sep"></div>
 154 <div class="menu">
 155   <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
 156 </div>
 157 <div class="sep"></div>
 158 <div class="menu">
 159   <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
 160 </div>
 161 <div  class="sub">
 162   <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
 163 </div>
 164 <div class="sep"></div>
 165 <div class="menu">
 166   <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
 167
 168   <a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 170 <div class="sponsbox">
 171 <div class="sponsor">
 172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 173 </div>
 174 <div class="sponsor">
 175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 176 </div>
 177 <div class="sponsor">
 178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 179 </div>
 180 <div class="sponsor">
 181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 182 </div>
 183 <div class="sponsor">
 184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 185 </div>
 186 <div class="sponsor">
 187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 188 </div>
 189 <div class="sponsor">
 190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 191 </div>
 192 <div class="sponsor">
 193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 194 </div>
 195 <div class="sponsor">
 196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 197 </div>
 198 <div class="sponsor">
 199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 200 </div>
 201 <div class="sponsor">
 202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 203 </div>
 204 <div class="sponsor">
 205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 206 </div>
 207 <div class="sponsor">
 208    <a rel="follow" title="Sponsor: Names List" href="http://www.listofnames.info">Names List</a><!-- 2012110100180 grimshrat@busyb-->
 209 </div>
 210 <div  class="sponsor">
 211    <a rel="follow" title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2012080100030 atlas-multimedia-->
 212 </div>
 213 </div>
 214 </div>
 215 </div>
 216
 217 <div class="eastbar">
 218   <div class="g-plusone" id="gplusone"></div>
 219   <script type="text/javascript">
 220     window.___gcfg = {
 221       lang: 'en-US'
 222     };
 223
 224     (function() {
 225       var po = document.createElement('script');
 226       po.type = 'text/javascript'; po.async = true;
 227       po.src = 'https://apis.google.com/js/plusone.js';
 228       var script = document.getElementsByTagName('script')[0];
 229       script.parentNode.insertBefore(po, script);
 230     })();
 231     var gplusone = document.getElementById("gplusone");
 232     gplusone.setAttribute("data-size","medium");
 233     gplusone.setAttribute("data-count","false");
 234   </script>
 235 </div>
 236
 237 <div class="main">
 238
 239 <h1>Module annotate Methods</h1>
 240 <p class="navigation-index">[<a href="annotate.html#AnnotateImage">AnnotateImage</a> &bull; <a href="annotate.html#FormatMagickCaption">FormatMagickCaption</a> &bull; <a href="annotate.html#GetMultilineTypeMetrics">GetMultilineTypeMetrics</a> &bull; <a href="annotate.html#GetTypeMetrics">GetTypeMetrics</a>]</p>
 241
 242 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="AnnotateImage">AnnotateImage</a></h2>
 243 <div class="doc-section">
 244
 245 <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>
 246
 247 <pre class="text">
 248       b   file size in bytes.
 249       c   comment.
 250       d   directory in which the image resides.
 251       e   extension of the image file.
 252       f   original filename of the image.
 253       h   height of image.
 254       i   filename of the image.
 255       k   number of unique colors.
 256       l   image label.
 257       m   image file format.
 258       n   number of images in a image sequence.
 259       o   output image filename.
 260       p   page number of the image.
 261       q   image depth (8 or 16).
 262       q   image depth (8 or 16).
 263       s   image scene number.
 264       t   image filename without any extension.
 265       u   a unique temporary filename.
 266       w   image width.
 267       x   x resolution of the image.
 268       y   y resolution of the image.
 269 </pre>
 270
 271 <p>The format of the AnnotateImage method is:</p>
 272
 273 <pre class="code">
 274   MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
 275 </pre>
 276
 277 <p>A description of each parameter follows:</p>
 278
 279 <h5>image</h5>
 280 <p>the image.</p>
 281
 282 <h5>draw_info</h5>
 283 <p>the draw info.</p>
 284
 285  </div>
 286 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="FormatMagickCaption">FormatMagickCaption</a></h2>
 287 <div class="doc-section">
 288
 289 <p>FormatMagickCaption() formats a caption so that it fits within the image width.  It returns the number of lines in the formatted caption.</p>
 290
 291 <p>The format of the FormatMagickCaption method is:</p>
 292
 293 <pre class="code">
 294   ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
 295     const MagickBooleanType split,TypeMetric *metrics,char **caption)
 296 </pre>
 297
 298 <p>A description of each parameter follows.</p>
 299
 300 <h5>image</h5>
 301 <p>The image.</p>
 302
 303 <h5>draw_info</h5>
 304 <p>the draw info.</p>
 305
 306 <h5>split</h5>
 307 <p>when no convenient line breaks-- insert newline.</p>
 308
 309 <h5>metrics</h5>
 310 <p>Return the font metrics in this structure.</p>
 311
 312 <h5>caption</h5>
 313 <p>the caption.</p>
 314
 315  </div>
 316 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
 317 <div class="doc-section">
 318
 319 <p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
 320
 321 <pre class="text">
 322       character width
 323       character height
 324       ascender
 325       descender
 326       text width
 327       text height
 328       maximum horizontal advance
 329       bounds: x1
 330       bounds: y1
 331       bounds: x2
 332       bounds: y2
 333       origin: x
 334       origin: y
 335       underline position
 336       underline thickness
 337 </pre>
 338
 339 <p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
 340
 341 <p>The format of the GetMultilineTypeMetrics method is:</p>
 342
 343 <pre class="code">
 344   MagickBooleanType GetMultilineTypeMetrics(Image *image,
 345     const DrawInfo *draw_info,TypeMetric *metrics)
 346 </pre>
 347
 348 <p>A description of each parameter follows:</p>
 349
 350 <h5>image</h5>
 351 <p>the image.</p>
 352
 353 <h5>draw_info</h5>
 354 <p>the draw info.</p>
 355
 356 <h5>metrics</h5>
 357 <p>Return the font metrics in this structure.</p>
 358
 359  </div>
 360 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="GetTypeMetrics">GetTypeMetrics</a></h2>
 361 <div class="doc-section">
 362
 363 <p>GetTypeMetrics() returns the following information for the specified font and text:</p>
 364
 365 <pre class="text">
 366       character width
 367       character height
 368       ascender
 369       descender
 370       text width
 371       text height
 372       maximum horizontal advance
 373       bounds: x1
 374       bounds: y1
 375       bounds: x2
 376       bounds: y2
 377       origin: x
 378       origin: y
 379       underline position
 380       underline thickness
 381 </pre>
 382
 383 <p>The format of the GetTypeMetrics method is:</p>
 384
 385 <pre class="code">
 386   MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
 387     TypeMetric *metrics)
 388 </pre>
 389
 390 <p>A description of each parameter follows:</p>
 391
 392 <h5>image</h5>
 393 <p>the image.</p>
 394
 395 <h5>draw_info</h5>
 396 <p>the draw info.</p>
 397
 398 <h5>metrics</h5>
 399 <p>Return the font metrics in this structure.</p>
 400
 401  </div>
 402
 403 </div>
 404
 405 <div id="linkbar">
 406     <span id="linkbar-west">&nbsp;</span>
 407     <span id="linkbar-center">
 408       <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
 409       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 410     </span>
 411     <span id="linkbar-east">&nbsp;</span>
 412   </div>
 413   <div class="footer">
 414     <span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>
 415     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
 416   </div>
 417   <div style="clear: both; margin: 0; width: 100%; "></div>
 418   <script type="text/javascript">
 419     var _gaq = _gaq || [];
 420     _gaq.push(['_setAccount', 'UA-17690367-1']);
 421     _gaq.push(['_trackPageview']);
 422
 423     (function() {
 424       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 425       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 426       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 427     })();
 428   </script>
 429 </body>
 430 </html>