Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3ed852eea50f9d4cd633efb8c2b054b8e33c2530 / . / www / api / annotate.html
blob: 4881f3f0350696ddb37288aefe7010f2fbc82865 [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +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>
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"/>
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
46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
49<div class="sep"></div>
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>
80<div class="sep"></div>
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>
105<div class="sep"></div>
106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
109<div class="sep"></div>
110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
113<div class="sep"></div>
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>
120<div class="sep"></div>
121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
126 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
127</div>
128<div class="sponsor">
129 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
130</div>
131<div class="sponsor">
132 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
139</div>
140</div>
141</div>
142
143
144</div>
145
146<div class="main">
147
148<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>
149
150<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
151_8c.html" target="source" name="AnnotateImage">AnnotateImage</a></h2>
152<div class="doc-section">
153
154<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>
155
156<pre class="text">
157 b file size in bytes.
158 c comment.
159 d directory in which the image resides.
160 e extension of the image file.
161 f original filename of the image.
162 h height of image.
163 i filename of the image.
164 k number of unique colors.
165 l image label.
166 m image file format.
167 n number of images in a image sequence.
168 o output image filename.
169 p page number of the image.
170 q image depth (8 or 16).
171 q image depth (8 or 16).
172 s image scene number.
173 t image filename without any extension.
174 u a unique temporary filename.
175 w image width.
176 x x resolution of the image.
177 y y resolution of the image.
178</pre>
179
180<p>The format of the AnnotateImage method is:</p>
181
182<pre class="code">
183 MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
184</pre>
185
186<p>A description of each parameter follows:</p></ol>
187
188<h5>image</h5>
189<ol><p>the image.</p></ol>
190
191<h5>draw_info</h5>
192<ol><p>the draw info.</p></ol>
193
194 </div>
195<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
196_8c.html" target="source" name="FormatMagickCaption">FormatMagickCaption</a></h2>
197<div class="doc-section">
198
199<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>
200
201<p>The format of the FormatMagickCaption method is:</p>
202
203<pre class="code">
204 long FormatMagickCaption(Image *image,DrawInfo *draw_info,
205 TypeMetric *metrics,char **caption)
206</pre>
207
208<p>A description of each parameter follows.</p></ol>
209
210<h5>image</h5>
211<ol><p>The image.</p></ol>
212
213<h5>caption</h5>
214<ol><p>the caption.</p></ol>
215
216<h5>draw_info</h5>
217<ol><p>the draw info.</p></ol>
218
219<h5>metrics</h5>
220<ol><p>Return the font metrics in this structure.</p></ol>
221
222 </div>
223<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
224_8c.html" target="source" name="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
225<div class="doc-section">
226
227<p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
228
229<pre class="text">
230 character width
231 character height
232 ascender
233 descender
234 text width
235 text height
236 maximum horizontal advance
237 bounds: x1
238 bounds: y1
239 bounds: x2
240 bounds: y2
241 origin: x
242 origin: y
243 underline position
244 underline thickness
245</pre>
246
247<p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
248
249<p>The format of the GetMultilineTypeMetrics method is:</p>
250
251<pre class="code">
252 MagickBooleanType GetMultilineTypeMetrics(Image *image,
253 const DrawInfo *draw_info,TypeMetric *metrics)
254</pre>
255
256<p>A description of each parameter follows:</p></ol>
257
258<h5>image</h5>
259<ol><p>the image.</p></ol>
260
261<h5>draw_info</h5>
262<ol><p>the draw info.</p></ol>
263
264<h5>metrics</h5>
265<ol><p>Return the font metrics in this structure.</p></ol>
266
267 </div>
268<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate
269_8c.html" target="source" name="GetTypeMetrics">GetTypeMetrics</a></h2>
270<div class="doc-section">
271
272<p>GetTypeMetrics() returns the following information for the specified font and text:</p>
273
274<pre class="text">
275 character width
276 character height
277 ascender
278 descender
279 text width
280 text height
281 maximum horizontal advance
282 bounds: x1
283 bounds: y1
284 bounds: x2
285 bounds: y2
286 origin: x
287 origin: y
288 underline position
289 underline thickness
290</pre>
291
292<p>The format of the GetTypeMetrics method is:</p>
293
294<pre class="code">
295 MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
296 TypeMetric *metrics)
297</pre>
298
299<p>A description of each parameter follows:</p></ol>
300
301<h5>image</h5>
302<ol><p>the image.</p></ol>
303
304<h5>draw_info</h5>
305<ol><p>the draw info.</p></ol>
306
307<h5>metrics</h5>
308<ol><p>Return the font metrics in this structure.</p></ol>
309
310 </div>
311
312</div>
313
314<div id="linkbar">
315 <!-- <span id="linkbar-west">&nbsp;</span> -->
316 <span id="linkbar-center">
317 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
318 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
319 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
320 </span>
321 <span id="linkbar-east">&nbsp;</span>
322 </div>
323 <div class="footer">
324 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
325 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
326 </div>
327 <div style="clear: both; margin: 0; width: 100%; "></div>
328</body>
329</html>