Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / c1c6166d512ecb270db88b2aacf650c86ddfda08 / . / www / api / annotate.html
blob: 7d78c746a590596e03fde4ee68e748cbcb6205b5 [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickCore, C API for ImageMagick: Annotate an Image</title>
12 <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="Generator" content="PHP"/>
16 <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"/>
17 <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."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]26</head>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]49<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
52</div>
53<div class="sub">
54 <a href="../../www/command-line-processing.html">Processing</a>
55</div>
56<div class="sub">
57 <a href="../../www/command-line-options.html">Options</a>
58</div>
59<div class="sub">
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
61</div>
62<div class="menu">
63 <a href="../../www/api.html">Program Interfaces</a>
64</div>
65<div class="sub">
66 <a href="../../www/magick-wand.html">MagickWand</a>
67</div>
68<div class="sub">
69 <a href="../../www/magick-core.html">MagickCore</a>
70</div>
71<div class="sub">
72 <a href="../../www/perl-magick.html">PerlMagick</a>
73</div>
74<div class="sub">
75 <a href="../../Magick++/">Magick++</a>
76</div>
77<div class="menu">
78 <a href="../../www/architecture.html">Architecture</a>
79</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
82 <a href="../../www/install-source.html">Install from Source</a>
83</div>
84<div class="sub">
85 <a href="../../www/install-source.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a href="../../www/install-source.html#windows">Windows</a>
89 </div>
90<div class="menu">
91 <a href="../../www/binary-releases.html">Binary Releases</a>
92</div>
93<div class="sub">
94 <a href="../../www/binary-releases.html#unix">Unix</a>
95</div>
96<div class="sub">
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
98</div>
99<div class="sub">
100 <a href="../../www/binary-releases.html#windows">Windows</a>
101</div>
102<div class="menu">
103 <a href="../../www/resources.html">Resources</a>
104</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]105<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]109<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
115 <a href="../../www/sitemap.html">Site Map</a>
116</div>
117<div class="sub">
118 <a href="../../www/links.html">Links</a>
119</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]120<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame^]126 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
127</div>
128<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]129 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
130</div>
131<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]132 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
133</div>
134<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]135 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
136</div>
137<div class="sponsor">
138 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
139</div>
140<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
142</div>
143<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]144 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145</div>
146</div>
147</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]148
149
150</div>
151
152<div class="main">
153
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154<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>
155
156<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
157_8c.html" target="source" name="AnnotateImage">AnnotateImage</a></h2>
158<div class="doc-section">
159
160<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>
161
162<pre class="text">
163 b file size in bytes.
164 c comment.
165 d directory in which the image resides.
166 e extension of the image file.
167 f original filename of the image.
168 h height of image.
169 i filename of the image.
170 k number of unique colors.
171 l image label.
172 m image file format.
173 n number of images in a image sequence.
174 o output image filename.
175 p page number of the image.
176 q image depth (8 or 16).
177 q image depth (8 or 16).
178 s image scene number.
179 t image filename without any extension.
180 u a unique temporary filename.
181 w image width.
182 x x resolution of the image.
183 y y resolution of the image.
184</pre>
185
186<p>The format of the AnnotateImage method is:</p>
187
188<pre class="code">
189 MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
190</pre>
191
192<p>A description of each parameter follows:</p></ol>
193
194<h5>image</h5>
195<ol><p>the image.</p></ol>
196
197<h5>draw_info</h5>
198<ol><p>the draw info.</p></ol>
199
200 </div>
201<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
202_8c.html" target="source" name="FormatMagickCaption">FormatMagickCaption</a></h2>
203<div class="doc-section">
204
205<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>
206
207<p>The format of the FormatMagickCaption method is:</p>
208
209<pre class="code">
210 long FormatMagickCaption(Image *image,DrawInfo *draw_info,
211 TypeMetric *metrics,char **caption)
212</pre>
213
214<p>A description of each parameter follows.</p></ol>
215
216<h5>image</h5>
217<ol><p>The image.</p></ol>
218
219<h5>caption</h5>
220<ol><p>the caption.</p></ol>
221
222<h5>draw_info</h5>
223<ol><p>the draw info.</p></ol>
224
225<h5>metrics</h5>
226<ol><p>Return the font metrics in this structure.</p></ol>
227
228 </div>
229<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
230_8c.html" target="source" name="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
231<div class="doc-section">
232
233<p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
234
235<pre class="text">
236 character width
237 character height
238 ascender
239 descender
240 text width
241 text height
242 maximum horizontal advance
243 bounds: x1
244 bounds: y1
245 bounds: x2
246 bounds: y2
247 origin: x
248 origin: y
249 underline position
250 underline thickness
251</pre>
252
253<p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
254
255<p>The format of the GetMultilineTypeMetrics method is:</p>
256
257<pre class="code">
258 MagickBooleanType GetMultilineTypeMetrics(Image *image,
259 const DrawInfo *draw_info,TypeMetric *metrics)
260</pre>
261
262<p>A description of each parameter follows:</p></ol>
263
264<h5>image</h5>
265<ol><p>the image.</p></ol>
266
267<h5>draw_info</h5>
268<ol><p>the draw info.</p></ol>
269
270<h5>metrics</h5>
271<ol><p>Return the font metrics in this structure.</p></ol>
272
273 </div>
274<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
275_8c.html" target="source" name="GetTypeMetrics">GetTypeMetrics</a></h2>
276<div class="doc-section">
277
278<p>GetTypeMetrics() returns the following information for the specified font and text:</p>
279
280<pre class="text">
281 character width
282 character height
283 ascender
284 descender
285 text width
286 text height
287 maximum horizontal advance
288 bounds: x1
289 bounds: y1
290 bounds: x2
291 bounds: y2
292 origin: x
293 origin: y
294 underline position
295 underline thickness
296</pre>
297
298<p>The format of the GetTypeMetrics method is:</p>
299
300<pre class="code">
301 MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
302 TypeMetric *metrics)
303</pre>
304
305<p>A description of each parameter follows:</p></ol>
306
307<h5>image</h5>
308<ol><p>the image.</p></ol>
309
310<h5>draw_info</h5>
311<ol><p>the draw info.</p></ol>
312
313<h5>metrics</h5>
314<ol><p>Return the font metrics in this structure.</p></ol>
315
316 </div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]317
318</div>
319
320<div id="linkbar">
321 <!-- <span id="linkbar-west">&nbsp;</span> -->
322 <span id="linkbar-center">
323 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
324 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristyc49f7992009-09-22 22:48:40 +0000[diff] [blame]325 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]326 </span>
327 <span id="linkbar-east">&nbsp;</span>
328 </div>
329 <div class="footer">
330 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
331 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
332 </div>
333 <div style="clear: both; margin: 0; width: 100%; "></div>
334</body>
335</html>