Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 689efa2792fc00b3418a812abcdc9bb76e5293b0 / . / www / api / annotate.html
blob: 08a337e08f7a28c3a2a5e3fdc4fb34452a89413d [file] [log] [blame]
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en" xsi:schemaLocation="http://www.w3.org/1999/xhtml http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]4 <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
5 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]6 <title>ImageMagick: MagickCore, C API for ImageMagick: Annotate an Image</title>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]7 <meta http-equiv="content-language" content="en-US"></meta>
8 <meta http-equiv="content-type" content="text/html; charset=utf-8"></meta>
9 <meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta>
10 <meta name="application-name" content="ImageMagick"></meta>
11 <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>
12 <meta name="application-url" content="http://www.imagemagick.org"></meta>
13 <meta name="generator" content="PHP"></meta>
14 <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>
15 <meta name="rating" content="GENERAL"></meta>
16 <meta name="robots" content="INDEX, FOLLOW"></meta>
17 <meta name="generator" content="ImageMagick Studio LLC"></meta>
18 <meta name="author" content="ImageMagick Studio LLC"></meta>
19 <meta name="revisit-after" content="2 DAYS"></meta>
20 <meta name="resource-type" content="document"></meta>
21 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta>
22 <meta name="distribution" content="Global"></meta>
23 <link rel="icon" href="../../images/wand.png"></link>
24 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"></link>
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]25 <link rel="canonical" href="http://www.imagemagick.org"></link>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]27
28 <!-- Add jQuery library -->
29 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
30
31 <!-- Add mousewheel plugin (this is optional) -->
32 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
33
34 <!-- Add fancyBox -->
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]35 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]36 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
37
38 <!-- Optionally add helpers - button, thumbnail and/or media -->
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]39 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]40 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
42
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]43 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]44 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
45
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]46 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]47 $(document).ready(function() {
48 $(".fancybox").fancybox();
49 });
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]50 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]51
52 <!-- ImageMagick style -->
53 <style type="text/css" media="all">
54 @import url("../../www/magick.css");
55 </style>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]56</head>
57
58<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]59
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]60
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]61
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]62<div class="titlebar">
63<div style="margin: 17px auto; float: left;">
64 <script type="text/javascript">
65 <!--
66 google_ad_client = "pub-3129977114552745";
67 google_ad_slot = "5439289906";
68 google_ad_width = 728;
69 google_ad_height = 90;
70 //-->
71 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]72
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]73</div>
cristy417eeb12013-07-28 18:48:22 +0000[diff] [blame]74<a href="../../discourse-server">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]75 <img src="../../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a>
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]76<a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]77 <img src="../../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]78</div>
79
80<div class="westbar">
81
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]83 <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]86 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]87</div>
88<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]89 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]90</div>
91<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]92 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]93</div>
94<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]95 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]96</div>
97<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]98 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]99</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]100<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]101<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]102 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]105 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]108 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]114 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]117 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]120 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]123 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
125<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]126 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]128<div class="sep"></div>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]129<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]130 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]133 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]136 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137 </div>
138<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]139 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]141<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]142 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]145 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristy3dfa2192013-02-24 22:46:05 +0000[diff] [blame]149 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]151<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]153 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]155<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]156 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]158<div class="sep"></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]159</div>
160
161<div class="eastbar">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]162
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]163 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]164 <noscript>
165 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]166 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0"></img></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]167 </noscript>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]168
169
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]170</div>
171
172<div class="main">
173
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]174<h1>Module annotate Methods</h1>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]175<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]176
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]177<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="AnnotateImage">AnnotateImage</a></h2>
178<div class="doc-section">
179
180<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>
181
182<pre class="text">
183 b file size in bytes.
184 c comment.
185 d directory in which the image resides.
186 e extension of the image file.
187 f original filename of the image.
188 h height of image.
189 i filename of the image.
190 k number of unique colors.
191 l image label.
192 m image file format.
193 n number of images in a image sequence.
194 o output image filename.
195 p page number of the image.
196 q image depth (8 or 16).
197 q image depth (8 or 16).
198 s image scene number.
199 t image filename without any extension.
200 u a unique temporary filename.
201 w image width.
202 x x resolution of the image.
203 y y resolution of the image.
204</pre>
205
206<p>The format of the AnnotateImage method is:</p>
207
208<pre class="code">
209 MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
210</pre>
211
212<p>A description of each parameter follows:</p>
213
214<h5>image</h5>
215<p>the image.</p>
216
217<h5>draw_info</h5>
218<p>the draw info.</p>
219
220 </div>
221<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="FormatMagickCaption">FormatMagickCaption</a></h2>
222<div class="doc-section">
223
224<p>FormatMagickCaption() formats a caption so that it fits within the image width. It returns the number of lines in the formatted caption.</p>
225
226<p>The format of the FormatMagickCaption method is:</p>
227
228<pre class="code">
229 ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
230 const MagickBooleanType split,TypeMetric *metrics,char **caption)
231</pre>
232
233<p>A description of each parameter follows.</p>
234
235<h5>image</h5>
236<p>The image.</p>
237
238<h5>draw_info</h5>
239<p>the draw info.</p>
240
241<h5>split</h5>
242<p>when no convenient line breaks-- insert newline.</p>
243
244<h5>metrics</h5>
245<p>Return the font metrics in this structure.</p>
246
247<h5>caption</h5>
248<p>the caption.</p>
249
250 </div>
251<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2>
252<div class="doc-section">
253
254<p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
255
256<pre class="text">
257 character width
258 character height
259 ascender
260 descender
261 text width
262 text height
263 maximum horizontal advance
264 bounds: x1
265 bounds: y1
266 bounds: x2
267 bounds: y2
268 origin: x
269 origin: y
270 underline position
271 underline thickness
272</pre>
273
274<p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
275
276<p>The format of the GetMultilineTypeMetrics method is:</p>
277
278<pre class="code">
279 MagickBooleanType GetMultilineTypeMetrics(Image *image,
280 const DrawInfo *draw_info,TypeMetric *metrics)
281</pre>
282
283<p>A description of each parameter follows:</p>
284
285<h5>image</h5>
286<p>the image.</p>
287
288<h5>draw_info</h5>
289<p>the draw info.</p>
290
291<h5>metrics</h5>
292<p>Return the font metrics in this structure.</p>
293
294 </div>
295<h2><a href="http://www.imagemagick.org/api/MagickCore/annotate_8c.html" id="GetTypeMetrics">GetTypeMetrics</a></h2>
296<div class="doc-section">
297
298<p>GetTypeMetrics() returns the following information for the specified font and text:</p>
299
300<pre class="text">
301 character width
302 character height
303 ascender
304 descender
305 text width
306 text height
307 maximum horizontal advance
308 bounds: x1
309 bounds: y1
310 bounds: x2
311 bounds: y2
312 origin: x
313 origin: y
314 underline position
315 underline thickness
316</pre>
317
318<p>The format of the GetTypeMetrics method is:</p>
319
320<pre class="code">
321 MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
322 TypeMetric *metrics)
323</pre>
324
325<p>A description of each parameter follows:</p>
326
327<h5>image</h5>
328<p>the image.</p>
329
330<h5>draw_info</h5>
331<p>the draw info.</p>
332
333<h5>metrics</h5>
334<p>Return the font metrics in this structure.</p>
335
336 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]337
338</div>
339
340<div id="linkbar">
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]341 <span id="linkbar-west"> </span>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]342
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]343 <span id="linkbar-center">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]344 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
345 <a href="../../discourse-server">Discourse Server</a> •
346 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]347 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]348 </span>
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]349 <span id="linkbar-east"> </span>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]350</div>
351<div class="footer">
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]352 <span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]353 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
354</div>
355<div style="clear: both; margin: 0; width: 100%; "></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]356</body>
357</html>