Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3eaa0efda2a6fd5d8e8426b53e578ddcacb1c45f / . / www / api / draw.html
blob: 793c64d893066348c212ebd7952999d5b8f0baf7 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +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 http-equiv="Content-Type" value="application/xhtml+xml" />
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
10 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Draw on an Image</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, draw, on, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18 <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."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../../www/architecture.html">Architecture</a>
80</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
83 <a href="../../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../../www/resources.html">Resources</a>
105</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
116 <a href="../../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../../www/links.html">Links</a>
120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy2cc51bc2010-03-06 17:29:36 +0000[diff] [blame]127 <a href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
cristy95524f92010-02-16 18:44:34 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131</div>
132<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000[diff] [blame]136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame]137</div>
138<div class="sponsor">
139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143</div>
144<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]145 <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]148 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]152
153
154</div>
155
156<div class="main">
157
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158<p class="navigation-index">[<a href="#AcquireDrawInfo">AcquireDrawInfo</a> &bull; <a href="#CloneDrawInfo">CloneDrawInfo</a> &bull; <a href="#DestroyDrawInfo">DestroyDrawInfo</a> &bull; <a href="#DrawAffineImage">DrawAffineImage</a> &bull; <a href="#DrawClipPath">DrawClipPath</a> &bull; <a href="#DrawImage">DrawImage</a> &bull; <a href="#DrawGradientImage">DrawGradientImage</a> &bull; <a href="#DrawPatternPath">DrawPatternPath</a> &bull; <a href="#DrawPrimitive">DrawPrimitive</a> &bull; <a href="#GetAffineMatrix">GetAffineMatrix</a>]</p>
159
160<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
161_8c.html" target="source" name="AcquireDrawInfo">AcquireDrawInfo</a></h2>
162<div class="doc-section">
163
164<p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p></ol>
165
166<p>The format of the AcquireDrawInfo method is:</p>
167
168<pre class="code">
169 DrawInfo *AcquireDrawInfo(void)
170</pre>
171
172 </div>
173<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
174_8c.html" target="source" name="CloneDrawInfo">CloneDrawInfo</a></h2>
175<div class="doc-section">
176
177<p>CloneDrawInfo() makes a copy of the given draw info structure. If NULL is specified, a new image info structure is created initialized to default values.</p></ol>
178
179<p>The format of the CloneDrawInfo method is:</p>
180
181<pre class="code">
182 DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
183 const DrawInfo *draw_info)
184</pre>
185
186<p>A description of each parameter follows:</p></ol>
187
188<h5>image_info</h5>
189<ol><p>the image info.</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/draw
196_8c.html" target="source" name="DestroyDrawInfo">DestroyDrawInfo</a></h2>
197<div class="doc-section">
198
199<p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p></ol>
200
201<p>The format of the DestroyDrawInfo method is:</p>
202
203<pre class="code">
204 DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
205</pre>
206
207<p>A description of each parameter follows:</p></ol>
208
209<h5>draw_info</h5>
210<ol><p>the draw info.</p></ol>
211
212 </div>
213<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
214_8c.html" target="source" name="DrawAffineImage">DrawAffineImage</a></h2>
215<div class="doc-section">
216
217<p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p></ol>
218
219<p>The format of the DrawAffineImage method is:</p>
220
221<pre class="code">
222 MagickBooleanType DrawAffineImage(Image *image,const Image *source,
223 const AffineMatrix *affine)
224</pre>
225
226<p>A description of each parameter follows:</p></ol>
227
228<h5>image</h5>
229<ol><p>the image.</p></ol>
230
231<h5>source</h5>
232<ol><p>the source image.</p></ol>
233
234<h5>affine</h5>
235<ol><p>the affine transform.</p></ol>
236
237 </div>
238<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
239_8c.html" target="source" name="DrawClipPath">DrawClipPath</a></h2>
240<div class="doc-section">
241
242<p>DrawClipPath() draws the clip path on the image mask.</p></ol>
243
244<p>The format of the DrawClipPath method is:</p>
245
246<pre class="code">
247 MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
248 const char *name)
249</pre>
250
251<p>A description of each parameter follows:</p></ol>
252
253<h5>image</h5>
254<ol><p>the image.</p></ol>
255
256<h5>draw_info</h5>
257<ol><p>the draw info.</p></ol>
258
259<h5>name</h5>
260<ol><p>the name of the clip path.</p></ol>
261
262 </div>
263<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
264_8c.html" target="source" name="DrawImage">DrawImage</a></h2>
265<div class="doc-section">
266
267<p>DrawImage() draws a graphic primitive on your image. The primitive may be represented as a string or filename. Precede the filename with an "at" sign (@) and the contents of the file are drawn on the image. You can affect how text is drawn by setting one or more members of the draw info structure.</p></ol>
268
269<p>The format of the DrawImage method is:</p>
270
271<pre class="code">
272 MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info)
273</pre>
274
275<p>A description of each parameter follows:</p></ol>
276
277<h5>image</h5>
278<ol><p>the image.</p></ol>
279
280<h5>draw_info</h5>
281<ol><p>the draw info.</p></ol>
282
283 </div>
284<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
285_8c.html" target="source" name="DrawGradientImage">DrawGradientImage</a></h2>
286<div class="doc-section">
287
288<p>DrawGradientImage() draws a linear gradient on the image.</p></ol>
289
290<p>The format of the DrawGradientImage method is:</p>
291
292<pre class="code">
293 MagickBooleanType DrawGradientImage(Image *image,
294 const DrawInfo *draw_info)
295</pre>
296
297<p>A description of each parameter follows:</p></ol>
298
299<h5>image</h5>
300<ol><p>the image.</p></ol>
301
302<h5>_info</h5>
303<ol><p>the draw info.</p></ol>
304
305 </div>
306<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
307_8c.html" target="source" name="DrawPatternPath">DrawPatternPath</a></h2>
308<div class="doc-section">
309
310<p>DrawPatternPath() draws a pattern.</p></ol>
311
312<p>The format of the DrawPatternPath method is:</p>
313
314<pre class="code">
315 MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
316 const char *name,Image **pattern)
317</pre>
318
319<p>A description of each parameter follows:</p></ol>
320
321<h5>image</h5>
322<ol><p>the image.</p></ol>
323
324<h5>draw_info</h5>
325<ol><p>the draw info.</p></ol>
326
327<h5>name</h5>
328<ol><p>the pattern name.</p></ol>
329
330<h5>image</h5>
331<ol><p>the image.</p></ol>
332
333 </div>
334<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
335_8c.html" target="source" name="DrawPrimitive">DrawPrimitive</a></h2>
336<div class="doc-section">
337
338<p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p></ol>
339
340<p>The format of the DrawPrimitive method is:</p>
341
342<pre class="code">
343 MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
344 PrimitiveInfo *primitive_info)
345</pre>
346
347<p>A description of each parameter follows:</p></ol>
348
349<h5>image</h5>
350<ol><p>the image.</p></ol>
351
352<h5>draw_info</h5>
353<ol><p>the draw info.</p></ol>
354
355<h5>primitive_info</h5>
356<ol><p>Specifies a pointer to a PrimitiveInfo structure.</p></ol>
357
358 </div>
359<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
360_8c.html" target="source" name="GetAffineMatrix">GetAffineMatrix</a></h2>
361<div class="doc-section">
362
363<p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p></ol>
364
365<p>The format of the GetAffineMatrix method is:</p>
366
367<pre class="code">
368 void GetAffineMatrix(AffineMatrix *affine_matrix)
369</pre>
370
371<p>A description of each parameter follows:</p></ol>
372
373<h5>affine_matrix</h5>
374<ol><p>the affine matrix.</p></ol>
375
376 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]377
378</div>
379
380<div id="linkbar">
381 <!-- <span id="linkbar-west">&nbsp;</span> -->
382 <span id="linkbar-center">
383 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
384 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
385 </span>
386 <span id="linkbar-east">&nbsp;</span>
387 </div>
388 <div class="footer">
389 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
390 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
391 </div>
392 <div style="clear: both; margin: 0; width: 100%; "></div>
393</body>
394</html>