blob: 6960bbc9e7f29ff5941bc428dfec644675389524 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: Annotate an Image</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +000016 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000024 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000025 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000027 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000028 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +000031 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000032 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000044</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000053 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000054<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +000056 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000057<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +000062<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000063
cristy3ed852e2009-09-05 21:47:34 +000064<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000065 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
cristy3eaa0ef2010-03-06 20:35:26 +000067<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000068<div class="menu">
cristybb503372010-05-27 20:51:26 +000069 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000082 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000083</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000085 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000086</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000089</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000091 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristybb503372010-05-27 20:51:26 +0000121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000141
142<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000147 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
159 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000160</div>
cristy3ed852e2009-09-05 21:47:34 +0000161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000164
cristyce69bb02010-07-27 19:49:46 +0000165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000181<h1>Module annotate
182 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000183<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>
184
cristy7a40ba82011-01-08 20:31:18 +0000185<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/annotate
186_8c.html" id="AnnotateImage">AnnotateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000187<div class="doc-section">
188
189<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>
190
191<pre class="text">
192 b file size in bytes.
193 c comment.
194 d directory in which the image resides.
195 e extension of the image file.
196 f original filename of the image.
197 h height of image.
198 i filename of the image.
199 k number of unique colors.
200 l image label.
201 m image file format.
202 n number of images in a image sequence.
203 o output image filename.
204 p page number of the image.
205 q image depth (8 or 16).
206 q image depth (8 or 16).
207 s image scene number.
208 t image filename without any extension.
209 u a unique temporary filename.
210 w image width.
211 x x resolution of the image.
212 y y resolution of the image.
213</pre>
214
215<p>The format of the AnnotateImage method is:</p>
216
217<pre class="code">
218 MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
219</pre>
220
cristy7a40ba82011-01-08 20:31:18 +0000221<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000222
223<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000224<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000225
226<h5>draw_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000227<p>the draw info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000228
229 </div>
cristy7a40ba82011-01-08 20:31:18 +0000230<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/annotate
231_8c.html" id="FormatMagickCaption">FormatMagickCaption</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000232<div class="doc-section">
233
cristy7a40ba82011-01-08 20:31:18 +0000234<p>FormatMagickCaption() formats a caption so that it fits within the image width. It returns the number of lines in the formatted caption.</p>
cristy3ed852e2009-09-05 21:47:34 +0000235
236<p>The format of the FormatMagickCaption method is:</p>
237
238<pre class="code">
cristybb503372010-05-27 20:51:26 +0000239 ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
cristyd0bd44a2010-09-24 12:38:11 +0000240 const MagickBooleanType split,TypeMetric *metrics,char **caption)
cristy3ed852e2009-09-05 21:47:34 +0000241</pre>
242
cristy7a40ba82011-01-08 20:31:18 +0000243<p>A description of each parameter follows.</p>
cristy3ed852e2009-09-05 21:47:34 +0000244
245<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000246<p>The image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000247
cristy3ed852e2009-09-05 21:47:34 +0000248<h5>draw_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000249<p>the draw info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000250
cristyd0bd44a2010-09-24 12:38:11 +0000251<h5>split</h5>
cristy7a40ba82011-01-08 20:31:18 +0000252<p>when no convenient line breaks-- insert newline.</p>
cristyd0bd44a2010-09-24 12:38:11 +0000253
cristy3ed852e2009-09-05 21:47:34 +0000254<h5>metrics</h5>
cristy7a40ba82011-01-08 20:31:18 +0000255<p>Return the font metrics in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000256
cristyd0bd44a2010-09-24 12:38:11 +0000257<h5>caption</h5>
cristy7a40ba82011-01-08 20:31:18 +0000258<p>the caption.</p>
cristyd0bd44a2010-09-24 12:38:11 +0000259
cristy3ed852e2009-09-05 21:47:34 +0000260 </div>
cristy7a40ba82011-01-08 20:31:18 +0000261<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/annotate
262_8c.html" id="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000263<div class="doc-section">
264
265<p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
266
267<pre class="text">
268 character width
269 character height
270 ascender
271 descender
272 text width
273 text height
274 maximum horizontal advance
275 bounds: x1
276 bounds: y1
277 bounds: x2
278 bounds: y2
279 origin: x
280 origin: y
281 underline position
282 underline thickness
283</pre>
284
cristy7a40ba82011-01-08 20:31:18 +0000285<p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000286
287<p>The format of the GetMultilineTypeMetrics method is:</p>
288
289<pre class="code">
290 MagickBooleanType GetMultilineTypeMetrics(Image *image,
291 const DrawInfo *draw_info,TypeMetric *metrics)
292</pre>
293
cristy7a40ba82011-01-08 20:31:18 +0000294<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000295
296<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000297<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000298
299<h5>draw_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000300<p>the draw info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000301
302<h5>metrics</h5>
cristy7a40ba82011-01-08 20:31:18 +0000303<p>Return the font metrics in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000304
305 </div>
cristy7a40ba82011-01-08 20:31:18 +0000306<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/annotate
307_8c.html" id="GetTypeMetrics">GetTypeMetrics</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000308<div class="doc-section">
309
310<p>GetTypeMetrics() returns the following information for the specified font and text:</p>
311
312<pre class="text">
313 character width
314 character height
315 ascender
316 descender
317 text width
318 text height
319 maximum horizontal advance
320 bounds: x1
321 bounds: y1
322 bounds: x2
323 bounds: y2
324 origin: x
325 origin: y
326 underline position
327 underline thickness
328</pre>
329
330<p>The format of the GetTypeMetrics method is:</p>
331
332<pre class="code">
333 MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
334 TypeMetric *metrics)
335</pre>
336
cristy7a40ba82011-01-08 20:31:18 +0000337<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000338
339<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000340<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000341
342<h5>draw_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000343<p>the draw info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000344
345<h5>metrics</h5>
cristy7a40ba82011-01-08 20:31:18 +0000346<p>Return the font metrics in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000347
348 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000349
350</div>
351
352<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000353 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000354 <span id="linkbar-center">
355 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000356 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000357 </span>
358 <span id="linkbar-east">&nbsp;</span>
359 </div>
360 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000361 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000362 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
363 </div>
364 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000365 <script type="text/javascript">
366 var _gaq = _gaq || [];
367 _gaq.push(['_setAccount', 'UA-17690367-1']);
368 _gaq.push(['_trackPageview']);
369
370 (function() {
371 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
372 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
373 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
374 })();
375 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000376</body>
377</html>