blob: f477a12f2f6017c2d7022743b1a893a607410c76 [file] [log] [blame]
cristy06f63f22012-10-31 00:50:07 +00001<!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"/>
cristyffb69ed2010-12-25 00:06:48 +000011 <title>ImageMagick: MagickCore, C API for ImageMagick: Annotate an Image</title>
cristy751980d2012-06-03 23:18:35 +000012 <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"/>
cristy72da67d2013-02-24 21:40:48 +000019 <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, Image, Processing, Automagically"/>
cristy751980d2012-06-03 23:18:35 +000020 <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"/>
cristy72da67d2013-02-24 21:40:48 +000026 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
cristy751980d2012-06-03 23:18:35 +000027 <meta name="distribution" content="Global"/>
cristy72da67d2013-02-24 21:40:48 +000028 <link rel="icon" href="../../images/wand.png"/>
29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
cristy06f63f22012-10-31 00:50:07 +000030 <link rel="canonical" href="http://www.imagemagick.org" />
31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy06f63f22012-10-31 00:50:07 +000032 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy72da67d2013-02-24 21:40:48 +000033 <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy06f63f22012-10-31 00:50:07 +000034 <style type="text/css" media="all">
cristyd8833bf2013-02-24 22:14:53 +000035 @import url("../../style/magick.html");
cristy06f63f22012-10-31 00:50:07 +000036 </style>
cristy72da67d2013-02-24 21:40:48 +000037 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
38 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
39 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>
40 <script type="text/javascript">
41 $(document).ready(function() {
42 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
43 'transitionIn' : 'elastic',
44 'transitionOut' : 'elastic',
45 'overlayShow' : false,
46 'opacity' : true
47 });
48 });
49 </script>
cristy06f63f22012-10-31 00:50:07 +000050</head>
51
52<body id="www-imagemagick-org">
53<div class="titlebar">
54<div style="margin: 17px auto; float: left;">
55 <script type="text/javascript">
56 <!--
57 google_ad_client = "pub-3129977114552745";
58 google_ad_slot = "5439289906";
59 google_ad_width = 728;
60 google_ad_height = 90;
61 //-->
62 </script>
63 <script type="text/javascript"
64 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
65 </script>
66</div>
cristy72da67d2013-02-24 21:40:48 +000067<a href="../../discourse-server">
68 <img src="../../images/logo.jpg"
cristy06f63f22012-10-31 00:50:07 +000069 alt="ImageMagick Logo"
70 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristyd8833bf2013-02-24 22:14:53 +000071<a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">
cristy72da67d2013-02-24 21:40:48 +000072 <img src="../../images/sprite.jpg"
cristy06f63f22012-10-31 00:50:07 +000073 alt="ImageMagick Sprite"
74 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
75</div>
76
77<div class="westbar">
78
cristy3ed852e2009-09-05 21:47:34 +000079<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +000080 <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
cristy3ed852e2009-09-05 21:47:34 +000082<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +000083 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +000084</div>
85<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +000086 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +000087</div>
88<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +000089 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +000090</div>
91<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +000092 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +000093</div>
94<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +000095 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +000096</div>
cristy06f63f22012-10-31 00:50:07 +000097<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +000098<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +000099 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000102 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
104<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000105 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
107<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
110<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000111 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
113<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000114 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000117 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000118</div>
119<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000120 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000121</div>
122<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000123 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
cristy06f63f22012-10-31 00:50:07 +0000125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000126<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000127 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000128</div>
129<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000130 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000131</div>
132<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000133 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000134 </div>
135<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000136 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
cristybb503372010-05-27 20:51:26 +0000138<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000139 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000140</div>
cristy3ed852e2009-09-05 21:47:34 +0000141<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000142 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000143</div>
cristy06f63f22012-10-31 00:50:07 +0000144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000145<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000146 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
cristy06f63f22012-10-31 00:50:07 +0000148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000149<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000150 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000151</div>
152<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000153 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000154</div>
cristy06f63f22012-10-31 00:50:07 +0000155<div class="sep"></div>
cristy72da67d2013-02-24 21:40:48 +0000156<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000157 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000158
cristy72da67d2013-02-24 21:40:48 +0000159<a href="http://www.networkredux.com">
160 <img src="../../images/networkredux.png" width="140" height="31" alt="[sponsor]"
161 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000162<div class="sponsbox">
cristy72da67d2013-02-24 21:40:48 +0000163<div class="sponsor">
cristyeed6cb62012-01-28 19:38:34 +0000164 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
165</div>
cristy72da67d2013-02-24 21:40:48 +0000166<div class="sponsor">
167 <a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... -->
cristy4bf6e232011-05-21 01:43:33 +0000168</div>
cristy751980d2012-06-03 23:18:35 +0000169<div class="sponsor">
cristy72da67d2013-02-24 21:40:48 +0000170 <a rel="follow" title="Sponsor: Best Local Services" href="http://www.openchime.com">Best Local Services</a><!-- 2012010100150 joey@openc... -->
171</div>
172<div class="sponsor">
173 <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
174</div>
175<div class="sponsor">
176 <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201201010090 barsh@inter... -->
177</div>
178<div class="sponsor">
179 <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj -->
180</div>
181<div class="sponsor">
182 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
183</div>
184<div class="sponsor">
185 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
186</div>
187<div class="sponsor">
188 <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
189</div>
190<div class="sponsor">
191 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
192</div>
193<div class="sponsor">
194 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
195</div>
196<div class="sponsor">
197 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
198</div>
199<div class="sponsor">
200 <a rel="follow" title="Sponsor: Günstige Turbolader" href="http://www.autoteile-carparts.de/">Günstige Turbolader</a><!-- 20111101000030 -->
201</div>
202<div class="sponsor">
203 <a rel="follow" title="Sponsor: Got Stripes?" href="http://www.stripeslawncare.org">Got Stripes?</a><!-- 2012010100150 brooks@stripes...-->
cristyec6b4752011-01-08 03:16:23 +0000204</div>
cristy3ed852e2009-09-05 21:47:34 +0000205</div>
206</div>
cristy06f63f22012-10-31 00:50:07 +0000207</div>
208
209<div class="eastbar">
210 <div class="g-plusone" id="gplusone"></div>
211 <script type="text/javascript">
212 window.___gcfg = {
213 lang: 'en-US'
214 };
215
216 (function() {
cristy18b955e2013-02-24 21:06:33 +0000217 var po = document.createElement('offline-script');
cristy06f63f22012-10-31 00:50:07 +0000218 po.type = 'text/javascript'; po.async = true;
219 po.src = 'https://apis.google.com/js/plusone.js';
cristy18b955e2013-02-24 21:06:33 +0000220 var script = document.getElementsByTagName('offline-script')[0];
cristy06f63f22012-10-31 00:50:07 +0000221 script.parentNode.insertBefore(po, script);
222 })();
223 var gplusone = document.getElementById("gplusone");
224 gplusone.setAttribute("data-size","medium");
225 gplusone.setAttribute("data-count","false");
226 </script>
227</div>
228
229<div class="main">
230
cristy20398432011-08-11 01:31:50 +0000231<h1>Module annotate Methods</h1>
cristyd8833bf2013-02-24 22:14:53 +0000232<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>
cristy3ed852e2009-09-05 21:47:34 +0000233
cristy20398432011-08-11 01:31:50 +0000234<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="AnnotateImage">AnnotateImage</a></h2>
235<div class="doc-section">
236
237<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>
238
239<pre class="text">
240 b file size in bytes.
241 c comment.
242 d directory in which the image resides.
243 e extension of the image file.
244 f original filename of the image.
245 h height of image.
246 i filename of the image.
247 k number of unique colors.
248 l image label.
249 m image file format.
250 n number of images in a image sequence.
251 o output image filename.
252 p page number of the image.
253 q image depth (8 or 16).
254 q image depth (8 or 16).
255 s image scene number.
256 t image filename without any extension.
257 u a unique temporary filename.
258 w image width.
259 x x resolution of the image.
260 y y resolution of the image.
261</pre>
262
263<p>The format of the AnnotateImage method is:</p>
264
265<pre class="code">
266 MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
267</pre>
268
269<p>A description of each parameter follows:</p>
270
271<h5>image</h5>
272<p>the image.</p>
273
274<h5>draw_info</h5>
275<p>the draw info.</p>
276
277 </div>
278<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="FormatMagickCaption">FormatMagickCaption</a></h2>
279<div class="doc-section">
280
281<p>FormatMagickCaption() formats a caption so that it fits within the image width. It returns the number of lines in the formatted caption.</p>
282
283<p>The format of the FormatMagickCaption method is:</p>
284
285<pre class="code">
286 ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
287 const MagickBooleanType split,TypeMetric *metrics,char **caption)
288</pre>
289
290<p>A description of each parameter follows.</p>
291
292<h5>image</h5>
293<p>The image.</p>
294
295<h5>draw_info</h5>
296<p>the draw info.</p>
297
298<h5>split</h5>
299<p>when no convenient line breaks-- insert newline.</p>
300
301<h5>metrics</h5>
302<p>Return the font metrics in this structure.</p>
303
304<h5>caption</h5>
305<p>the caption.</p>
306
307 </div>
308<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
309<div class="doc-section">
310
311<p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
312
313<pre class="text">
314 character width
315 character height
316 ascender
317 descender
318 text width
319 text height
320 maximum horizontal advance
321 bounds: x1
322 bounds: y1
323 bounds: x2
324 bounds: y2
325 origin: x
326 origin: y
327 underline position
328 underline thickness
329</pre>
330
331<p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
332
333<p>The format of the GetMultilineTypeMetrics method is:</p>
334
335<pre class="code">
336 MagickBooleanType GetMultilineTypeMetrics(Image *image,
337 const DrawInfo *draw_info,TypeMetric *metrics)
338</pre>
339
340<p>A description of each parameter follows:</p>
341
342<h5>image</h5>
343<p>the image.</p>
344
345<h5>draw_info</h5>
346<p>the draw info.</p>
347
348<h5>metrics</h5>
349<p>Return the font metrics in this structure.</p>
350
351 </div>
352<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="GetTypeMetrics">GetTypeMetrics</a></h2>
353<div class="doc-section">
354
355<p>GetTypeMetrics() returns the following information for the specified font and text:</p>
356
357<pre class="text">
358 character width
359 character height
360 ascender
361 descender
362 text width
363 text height
364 maximum horizontal advance
365 bounds: x1
366 bounds: y1
367 bounds: x2
368 bounds: y2
369 origin: x
370 origin: y
371 underline position
372 underline thickness
373</pre>
374
375<p>The format of the GetTypeMetrics method is:</p>
376
377<pre class="code">
378 MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
379 TypeMetric *metrics)
380</pre>
381
382<p>A description of each parameter follows:</p>
383
384<h5>image</h5>
385<p>the image.</p>
386
387<h5>draw_info</h5>
388<p>the draw info.</p>
389
390<h5>metrics</h5>
391<p>Return the font metrics in this structure.</p>
392
393 </div>
cristy06f63f22012-10-31 00:50:07 +0000394
395</div>
396
397<div id="linkbar">
398 <span id="linkbar-west">&nbsp;</span>
399 <span id="linkbar-center">
cristy72da67d2013-02-24 21:40:48 +0000400 <a href="../../discourse-server">Discourse Server</a> &bull;
cristy06f63f22012-10-31 00:50:07 +0000401 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
402 </span>
403 <span id="linkbar-east">&nbsp;</span>
404 </div>
405 <div class="footer">
cristy72da67d2013-02-24 21:40:48 +0000406 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristyd8833bf2013-02-24 22:14:53 +0000407 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
cristy06f63f22012-10-31 00:50:07 +0000408 </div>
409 <div style="clear: both; margin: 0; width: 100%; "></div>
410 <script type="text/javascript">
411 var _gaq = _gaq || [];
412 _gaq.push(['_setAccount', 'UA-17690367-1']);
413 _gaq.push(['_trackPageview']);
414
415 (function() {
cristy18b955e2013-02-24 21:06:33 +0000416 var ga = document.createElement('offline-script'); ga.type = 'text/javascript'; ga.async = true;
cristy06f63f22012-10-31 00:50:07 +0000417 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
cristy18b955e2013-02-24 21:06:33 +0000418 var s = document.getElementsByTagName('offline-script')[0]; s.parentNode.insertBefore(ga, s);
cristy06f63f22012-10-31 00:50:07 +0000419 })();
420 </script>
421</body>
422</html>