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">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\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="screen,projection"><!--\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 href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 146 </div>
 147 <div  class="sponsor">
 148    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <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>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 161 _8c.html" target="source" name="AnnotateImage">AnnotateImage</a></h2>
 162 <div class="doc-section">
 163
 164 <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>
 165
 166 <pre class="text">
 167       b   file size in bytes.
 168       c   comment.
 169       d   directory in which the image resides.
 170       e   extension of the image file.
 171       f   original filename of the image.
 172       h   height of image.
 173       i   filename of the image.
 174       k   number of unique colors.
 175       l   image label.
 176       m   image file format.
 177       n   number of images in a image sequence.
 178       o   output image filename.
 179       p   page number of the image.
 180       q   image depth (8 or 16).
 181       q   image depth (8 or 16).
 182       s   image scene number.
 183       t   image filename without any extension.
 184       u   a unique temporary filename.
 185       w   image width.
 186       x   x resolution of the image.
 187       y   y resolution of the image.
 188 </pre>
 189
 190 <p>The format of the AnnotateImage method is:</p>
 191
 192 <pre class="code">
 193   MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
 194 </pre>
 195
 196 <p>A description of each parameter follows:</p></ol>
 197
 198 <h5>image</h5>
 199 <ol><p>the image.</p></ol>
 200
 201 <h5>draw_info</h5>
 202 <ol><p>the draw info.</p></ol>
 203
 204  </div>
 205 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 206 _8c.html" target="source" name="FormatMagickCaption">FormatMagickCaption</a></h2>
 207 <div class="doc-section">
 208
 209 <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>
 210
 211 <p>The format of the FormatMagickCaption method is:</p>
 212
 213 <pre class="code">
 214   long FormatMagickCaption(Image *image,DrawInfo *draw_info,
 215     TypeMetric *metrics,char **caption)
 216 </pre>
 217
 218 <p>A description of each parameter follows.</p></ol>
 219
 220 <h5>image</h5>
 221 <ol><p>The image.</p></ol>
 222
 223 <h5>caption</h5>
 224 <ol><p>the caption.</p></ol>
 225
 226 <h5>draw_info</h5>
 227 <ol><p>the draw info.</p></ol>
 228
 229 <h5>metrics</h5>
 230 <ol><p>Return the font metrics in this structure.</p></ol>
 231
 232  </div>
 233 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 234 _8c.html" target="source" name="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
 235 <div class="doc-section">
 236
 237 <p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
 238
 239 <pre class="text">
 240       character width
 241       character height
 242       ascender
 243       descender
 244       text width
 245       text height
 246       maximum horizontal advance
 247       bounds: x1
 248       bounds: y1
 249       bounds: x2
 250       bounds: y2
 251       origin: x
 252       origin: y
 253       underline position
 254       underline thickness
 255 </pre>
 256
 257 <p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
 258
 259 <p>The format of the GetMultilineTypeMetrics method is:</p>
 260
 261 <pre class="code">
 262   MagickBooleanType GetMultilineTypeMetrics(Image *image,
 263     const DrawInfo *draw_info,TypeMetric *metrics)
 264 </pre>
 265
 266 <p>A description of each parameter follows:</p></ol>
 267
 268 <h5>image</h5>
 269 <ol><p>the image.</p></ol>
 270
 271 <h5>draw_info</h5>
 272 <ol><p>the draw info.</p></ol>
 273
 274 <h5>metrics</h5>
 275 <ol><p>Return the font metrics in this structure.</p></ol>
 276
 277  </div>
 278 <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
 279 _8c.html" target="source" name="GetTypeMetrics">GetTypeMetrics</a></h2>
 280 <div class="doc-section">
 281
 282 <p>GetTypeMetrics() returns the following information for the specified font and text:</p>
 283
 284 <pre class="text">
 285       character width
 286       character height
 287       ascender
 288       descender
 289       text width
 290       text height
 291       maximum horizontal advance
 292       bounds: x1
 293       bounds: y1
 294       bounds: x2
 295       bounds: y2
 296       origin: x
 297       origin: y
 298       underline position
 299       underline thickness
 300 </pre>
 301
 302 <p>The format of the GetTypeMetrics method is:</p>
 303
 304 <pre class="code">
 305   MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
 306     TypeMetric *metrics)
 307 </pre>
 308
 309 <p>A description of each parameter follows:</p></ol>
 310
 311 <h5>image</h5>
 312 <ol><p>the image.</p></ol>
 313
 314 <h5>draw_info</h5>
 315 <ol><p>the draw info.</p></ol>
 316
 317 <h5>metrics</h5>
 318 <ol><p>Return the font metrics in this structure.</p></ol>
 319
 320  </div>
 321 \r
 322 </div>\r
 323 \r
 324 <div id="linkbar">\r
 325  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 326     <span id="linkbar-center">\r
 327       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 328     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 329     </span>\r
 330     <span id="linkbar-east">&nbsp;</span>\r
 331   </div>\r
 332   <div class="footer">\r
 333     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 334     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 335   </div>\r
 336   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 337 </body>\r
 338 </html>\r