| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
|
| <head>
|
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
| <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
|
| <title>ImageMagick: MagickCore, C API for ImageMagick: Annotate an Image</title> |
| <meta http-equiv="Content-Language" content="en-US"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> |
| <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/> |
| <meta name="Application-name" content="ImageMagick"/> |
| <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/> |
| <meta name="Application-url" content="http://www.imagemagick.org"/> |
| <meta name="Generator" content="PHP"/> |
| <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"/> |
| <meta name="Rating" content="GENERAL"/> |
| <meta name="Robots" content="INDEX, FOLLOW"/> |
| <meta name="Generator" content="ImageMagick Studio LLC"/> |
| <meta name="Author" content="ImageMagick Studio LLC"/> |
| <meta name="Revisit-after" content="2 DAYS"/> |
| <meta name="Resource-type" content="document"/> |
| <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/> |
| <meta name="Distribution" content="Global"/> |
| <link rel="icon" href="../../images/wand.png" sizes="32x32"/> |
| <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/> |
| <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
|
| <style type="text/css" media="all">
|
| @import url("../../www/magick.css");
|
| </style>
|
| </head>
|
|
|
| <body id="www-imagemagick-org">
|
| <div class="titlebar">
|
| <a href="../../index.html">
|
| <img src="../../images/script.png" alt="[ImageMagick]"
|
| style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
|
| <a href="http://www.networkredux.com">
|
| <img src="../../images/networkredux.png" alt="[sponsor]"
|
| style="margin: 45px auto; border: 0px; float: left;" /></a>
|
| <a href="http://www.imagemagick.org/discourse-server/">
|
| <img src="../../images/logo.jpg" alt=""
|
| style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
|
| <a href="../../index.html">
|
| <img src="../../images/sprite.jpg" alt=""
|
| style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
|
| </div>
|
|
|
| <div class="westbar">
|
|
|
| <div class="menu"> |
| <a title="About ImageMagick" href="../../index.html">About ImageMagick</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a> |
| </div> |
| <div class="menu"> |
| <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Install from Source" href="../../www/install-source.html">Install from Source</a> |
| </div> |
| <div class="sub"> |
| <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a> |
| </div> |
| <div class="sub"> |
| <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a> |
| </div> |
| <div class="menu"> |
| <a title="Resources" href="../../www/resources.html">Resources</a> |
| </div> |
| <div class="menu"> |
| <a title="Architecture" href="../../www/architecture.html">Architecture</a> |
| </div> |
| <div class="menu"> |
| <a title="Download" href="../../www/download.html">Download</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Site Map" href="../../www/sitemap.html">Site Map</a> |
| </div> |
| <div class="sub"> |
| <a title="Site Map: Links" href="../../www/links.html">Links</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a> |
| |
| <div class="sponsbox"> |
| <div class="sponsor"> |
| <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011040100025 atlas.multimedia--> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee--> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter--> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de--> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen--> |
| </div> |
| </div> |
| </div> |
| </div>
|
|
|
| <div class="eastbar">
|
| <script type="text/javascript">
|
| <!--
|
| google_ad_client = "pub-3129977114552745";
|
| google_ad_slot = "0574824969";
|
| google_ad_width = 160;
|
| google_ad_height = 600;
|
| //-->
|
| </script>
|
| <script type="text/javascript"
|
| src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
|
| </script>
|
| </div>
|
|
|
| <div class="main">
|
|
|
| <h1>Module annotate |
| Methods</h1> |
| <p class="navigation-index">[<a href="#AnnotateImage">AnnotateImage</a> • <a href="#FormatMagickCaption">FormatMagickCaption</a> • <a href="#GetMultilineTypeMetrics">GetMultilineTypeMetrics</a> • <a href="#GetTypeMetrics">GetTypeMetrics</a>]</p> |
| |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate |
| _8c.html" target="source" name="AnnotateImage">AnnotateImage</a></h2> |
| <div class="doc-section"> |
| |
| <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> |
| |
| <pre class="text"> |
| b file size in bytes. |
| c comment. |
| d directory in which the image resides. |
| e extension of the image file. |
| f original filename of the image. |
| h height of image. |
| i filename of the image. |
| k number of unique colors. |
| l image label. |
| m image file format. |
| n number of images in a image sequence. |
| o output image filename. |
| p page number of the image. |
| q image depth (8 or 16). |
| q image depth (8 or 16). |
| s image scene number. |
| t image filename without any extension. |
| u a unique temporary filename. |
| w image width. |
| x x resolution of the image. |
| y y resolution of the image. |
| </pre> |
| |
| <p>The format of the AnnotateImage method is:</p> |
| |
| <pre class="code"> |
| MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info) |
| </pre> |
| |
| <p>A description of each parameter follows:</p></ol> |
| |
| <h5>image</h5> |
| <ol><p>the image.</p></ol> |
| |
| <h5>draw_info</h5> |
| <ol><p>the draw info.</p></ol> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate |
| _8c.html" target="source" name="FormatMagickCaption">FormatMagickCaption</a></h2> |
| <div class="doc-section"> |
| |
| <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> |
| |
| <p>The format of the FormatMagickCaption method is:</p> |
| |
| <pre class="code"> |
| ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info, |
| const MagickBooleanType split,TypeMetric *metrics,char **caption) |
| </pre> |
| |
| <p>A description of each parameter follows.</p></ol> |
| |
| <h5>image</h5> |
| <ol><p>The image.</p></ol> |
| |
| <h5>draw_info</h5> |
| <ol><p>the draw info.</p></ol> |
| |
| <h5>split</h5> |
| <ol><p>when no convenient line breaks-- insert newline.</p></ol> |
| |
| <h5>metrics</h5> |
| <ol><p>Return the font metrics in this structure.</p></ol> |
| |
| <h5>caption</h5> |
| <ol><p>the caption.</p></ol> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate |
| _8c.html" target="source" name="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2> |
| <div class="doc-section"> |
| |
| <p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p> |
| |
| <pre class="text"> |
| character width |
| character height |
| ascender |
| descender |
| text width |
| text height |
| maximum horizontal advance |
| bounds: x1 |
| bounds: y1 |
| bounds: x2 |
| bounds: y2 |
| origin: x |
| origin: y |
| underline position |
| underline thickness |
| </pre> |
| |
| <p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol> |
| |
| <p>The format of the GetMultilineTypeMetrics method is:</p> |
| |
| <pre class="code"> |
| MagickBooleanType GetMultilineTypeMetrics(Image *image, |
| const DrawInfo *draw_info,TypeMetric *metrics) |
| </pre> |
| |
| <p>A description of each parameter follows:</p></ol> |
| |
| <h5>image</h5> |
| <ol><p>the image.</p></ol> |
| |
| <h5>draw_info</h5> |
| <ol><p>the draw info.</p></ol> |
| |
| <h5>metrics</h5> |
| <ol><p>Return the font metrics in this structure.</p></ol> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate |
| _8c.html" target="source" name="GetTypeMetrics">GetTypeMetrics</a></h2> |
| <div class="doc-section"> |
| |
| <p>GetTypeMetrics() returns the following information for the specified font and text:</p> |
| |
| <pre class="text"> |
| character width |
| character height |
| ascender |
| descender |
| text width |
| text height |
| maximum horizontal advance |
| bounds: x1 |
| bounds: y1 |
| bounds: x2 |
| bounds: y2 |
| origin: x |
| origin: y |
| underline position |
| underline thickness |
| </pre> |
| |
| <p>The format of the GetTypeMetrics method is:</p> |
| |
| <pre class="code"> |
| MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info, |
| TypeMetric *metrics) |
| </pre> |
| |
| <p>A description of each parameter follows:</p></ol> |
| |
| <h5>image</h5> |
| <ol><p>the image.</p></ol> |
| |
| <h5>draw_info</h5> |
| <ol><p>the draw info.</p></ol> |
| |
| <h5>metrics</h5> |
| <ol><p>Return the font metrics in this structure.</p></ol> |
| |
| </div> |
|
|
| </div>
|
|
|
| <div id="linkbar">
|
| <span id="linkbar-west"> </span>
|
| <span id="linkbar-center">
|
| <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
|
| <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
|
| </span>
|
| <span id="linkbar-east"> </span>
|
| </div>
|
| <div class="footer">
|
| <span id="footer-west">© 1999-2011 ImageMagick Studio LLC</span>
|
| <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
|
| </div>
|
| <div style="clear: both; margin: 0; width: 100%; "></div>
|
| <script type="text/javascript">
|
| var _gaq = _gaq || [];
|
| _gaq.push(['_setAccount', 'UA-17690367-1']);
|
| _gaq.push(['_trackPageview']);
|
|
|
| (function() {
|
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
| })();
|
| </script>
|
| </body>
|
| </html>
|