| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| <html version="-//W3C//DTD XHTML 1.1//EN" |
| xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xsi:schemaLocation="http://www.w3.org/1999/xhtml |
| http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8"/> |
| <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/> |
| <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="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."/> |
| <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, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/> |
| <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-2012 ImageMagick Studio LLC"/> |
| <meta name="distribution" content="Global"/> |
| <link rel="icon" href="../../images/wand.png"/> |
| <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/> |
| <link rel="canonical" href="../../index.html" /> |
| <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/> |
| |
| <!-- Add jQuery library --> |
| <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script> |
| |
| <!-- Add mousewheel plugin (this is optional) --> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script> |
| |
| <!-- Add fancyBox --> |
| <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen" /> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script> |
| |
| <!-- Optionally add helpers - button, thumbnail and/or media --> |
| <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen" /> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script> |
| |
| <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen" /> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script> |
| |
| <script type="text/javascript"> |
| $(document).ready(function() { |
| $(".fancybox").fancybox(); |
| }); |
| </script> |
| |
| <!-- ImageMagick style --> |
| <style type="text/css" media="all"> |
| @import url("../../www/magick.css"); |
| </style> |
| </head> |
| |
| <body id="www-imagemagick-org"> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'offline-script','//www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-40133312-1', 'imagemagick.org'); |
| ga('send', 'pageview'); |
| </script> |
| |
| <div class="titlebar"> |
| <div style="margin: 17px auto; float: left;"> |
| <script type="text/javascript"> |
| <!-- |
| google_ad_client = "pub-3129977114552745"; |
| google_ad_slot = "5439289906"; |
| google_ad_width = 728; |
| google_ad_height = 90; |
| //--> |
| </script> |
| <script type="text/javascript" |
| src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> |
| </script> |
| </div> |
| <a href="../../discourse-server"> |
| <img src="../../images/logo.jpg" |
| alt="ImageMagick Logo" |
| style="width: 123px; height: 118px; border: 0px; float: right;" /></a> |
| <a href="../../index.html"> |
| <img src="../../images/sprite.jpg" |
| alt="ImageMagick Sprite" |
| 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="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: iOS" href="../../www/binary-releases.html#iOS">iOS</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="../../www/magick++.html">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="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a> |
| </div> |
| </div> |
| |
| <div class="eastbar"> |
| <script type="text/javascript"> |
| /* <![CDATA[ */ |
| (function() { |
| var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0]; |
| po.type = 'text/javascript'; |
| po.async = true; |
| po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto'; |
| var script = document.getElementsByTagName('offline-script')[0]; |
| script.parentNode.insertBefore(po, script); |
| })(); |
| /* ]]> */ |
| </script> |
| <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a></div> |
| <noscript> |
| <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank"> |
| <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a> |
| </noscript> |
| <div class="g-plusone" id="gplusone"></div> |
| <script type="text/javascript"> |
| /* <![CDATA[ */ |
| window.___gcfg = { |
| lang: 'en-US' |
| }; |
| |
| (function() { |
| var po = document.createElement('offline-script'); |
| po.type = 'text/javascript'; |
| po.async = true; |
| po.src = 'https://apis.google.com/js/plusone.js'; |
| var script = document.getElementsByTagName('offline-script')[0]; |
| script.parentNode.insertBefore(po, script); |
| })(); |
| var gplusone = document.getElementById("gplusone"); |
| gplusone.setAttribute("data-size","medium"); |
| gplusone.setAttribute("data-count","true"); |
| /* ]]> */ |
| </script> |
| </div> |
| |
| <div class="main"> |
| |
| <h1>Module annotate Methods</h1> |
| <p class="navigation-index">[<a href="annotate.html#AnnotateImage">AnnotateImage</a> • <a href="annotate.html#FormatMagickCaption">FormatMagickCaption</a> • <a href="annotate.html#GetMultilineTypeMetrics">GetMultilineTypeMetrics</a> • <a href="annotate.html#GetTypeMetrics">GetTypeMetrics</a>]</p> |
| |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="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> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>draw_info</h5> |
| <p>the draw info.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="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> |
| |
| <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> |
| |
| <h5>image</h5> |
| <p>The image.</p> |
| |
| <h5>draw_info</h5> |
| <p>the draw info.</p> |
| |
| <h5>split</h5> |
| <p>when no convenient line breaks-- insert newline.</p> |
| |
| <h5>metrics</h5> |
| <p>Return the font metrics in this structure.</p> |
| |
| <h5>caption</h5> |
| <p>the caption.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="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> |
| |
| <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> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>draw_info</h5> |
| <p>the draw info.</p> |
| |
| <h5>metrics</h5> |
| <p>Return the font metrics in this structure.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="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> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>draw_info</h5> |
| <p>the draw info.</p> |
| |
| <h5>metrics</h5> |
| <p>Return the font metrics in this structure.</p> |
| |
| </div> |
| |
| </div> |
| |
| <div id="linkbar"> |
| <span id="linkbar-west"> </span> |
| |
| <span id="linkbar-center"> |
| <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • |
| <a href="../../discourse-server">Discourse Server</a> • |
| <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> • |
| <a href="http://jqmagick.imagemagick.org/">JqMagick</a> |
| </span> |
| <span id="linkbar-east"> </span> |
| </div> |
| <div class="footer"> |
| <span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span> |
| <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span> |
| </div> |
| <div style="clear: both; margin: 0; width: 100%; "></div> |
| </body> |
| </html> |