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="eastbar">\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="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</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: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a title="Resources" href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 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: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 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: Online-Magazin" href="http://www.unkostenbeitrag.de/" title="Online-Magazin">Online-Magazin</a><!-- 20101101000200 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <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>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 158 _8c.html" target="source" name="AnnotateImage">AnnotateImage</a></h2>
 159 <div class="doc-section">
 160
 161 <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>
 162
 163 <pre class="text">
 164       b   file size in bytes.
 165       c   comment.
 166       d   directory in which the image resides.
 167       e   extension of the image file.
 168       f   original filename of the image.
 169       h   height of image.
 170       i   filename of the image.
 171       k   number of unique colors.
 172       l   image label.
 173       m   image file format.
 174       n   number of images in a image sequence.
 175       o   output image filename.
 176       p   page number of the image.
 177       q   image depth (8 or 16).
 178       q   image depth (8 or 16).
 179       s   image scene number.
 180       t   image filename without any extension.
 181       u   a unique temporary filename.
 182       w   image width.
 183       x   x resolution of the image.
 184       y   y resolution of the image.
 185 </pre>
 186
 187 <p>The format of the AnnotateImage method is:</p>
 188
 189 <pre class="code">
 190   MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
 191 </pre>
 192
 193 <p>A description of each parameter follows:</p></ol>
 194
 195 <h5>image</h5>
 196 <ol><p>the image.</p></ol>
 197
 198 <h5>draw_info</h5>
 199 <ol><p>the draw info.</p></ol>
 200
 201  </div>
 202 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 203 _8c.html" target="source" name="FormatMagickCaption">FormatMagickCaption</a></h2>
 204 <div class="doc-section">
 205
 206 <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>
 207
 208 <p>The format of the FormatMagickCaption method is:</p>
 209
 210 <pre class="code">
 211   long FormatMagickCaption(Image *image,DrawInfo *draw_info,
 212     TypeMetric *metrics,char **caption)
 213 </pre>
 214
 215 <p>A description of each parameter follows.</p></ol>
 216
 217 <h5>image</h5>
 218 <ol><p>The image.</p></ol>
 219
 220 <h5>caption</h5>
 221 <ol><p>the caption.</p></ol>
 222
 223 <h5>draw_info</h5>
 224 <ol><p>the draw info.</p></ol>
 225
 226 <h5>metrics</h5>
 227 <ol><p>Return the font metrics in this structure.</p></ol>
 228
 229  </div>
 230 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 231 _8c.html" target="source" name="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
 232 <div class="doc-section">
 233
 234 <p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
 235
 236 <pre class="text">
 237       character width
 238       character height
 239       ascender
 240       descender
 241       text width
 242       text height
 243       maximum horizontal advance
 244       bounds: x1
 245       bounds: y1
 246       bounds: x2
 247       bounds: y2
 248       origin: x
 249       origin: y
 250       underline position
 251       underline thickness
 252 </pre>
 253
 254 <p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
 255
 256 <p>The format of the GetMultilineTypeMetrics method is:</p>
 257
 258 <pre class="code">
 259   MagickBooleanType GetMultilineTypeMetrics(Image *image,
 260     const DrawInfo *draw_info,TypeMetric *metrics)
 261 </pre>
 262
 263 <p>A description of each parameter follows:</p></ol>
 264
 265 <h5>image</h5>
 266 <ol><p>the image.</p></ol>
 267
 268 <h5>draw_info</h5>
 269 <ol><p>the draw info.</p></ol>
 270
 271 <h5>metrics</h5>
 272 <ol><p>Return the font metrics in this structure.</p></ol>
 273
 274  </div>
 275 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 276 _8c.html" target="source" name="GetTypeMetrics">GetTypeMetrics</a></h2>
 277 <div class="doc-section">
 278
 279 <p>GetTypeMetrics() 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>The format of the GetTypeMetrics method is:</p>
 300
 301 <pre class="code">
 302   MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
 303     TypeMetric *metrics)
 304 </pre>
 305
 306 <p>A description of each parameter follows:</p></ol>
 307
 308 <h5>image</h5>
 309 <ol><p>the image.</p></ol>
 310
 311 <h5>draw_info</h5>
 312 <ol><p>the draw info.</p></ol>
 313
 314 <h5>metrics</h5>
 315 <ol><p>Return the font metrics in this structure.</p></ol>
 316
 317  </div>
 318 \r
 319 </div>\r
 320 \r
 321 <div id="linkbar">\r
 322  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 323     <span id="linkbar-center">\r
 324       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 325     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 326     </span>\r
 327     <span id="linkbar-east">&nbsp;</span>\r
 328   </div>\r
 329   <div class="footer">\r
 330     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 331     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 332   </div>\r
 333   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 334 </body>\r
 335 </html>\r