blob: 9304210ff7ffc360004be4b7104ecfc8c0e4e65d [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: Draw on 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:, draw, on, 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"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristydcca3fa2010-12-29 21:50:07 +000030 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000031 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
32 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
33 <script type="text/javascript">
34 $(document).ready(function() {
35 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
36 'transitionIn' : 'elastic',
37 'transitionOut' : 'elastic',
38 'overlayShow' : false,
39 'opacity' : true
40 });
41 });
42 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000043</head>
44
45<body id="www-imagemagick-org">
46<div class="titlebar">
47<a href="../../index.html">
48 <img src="../../images/script.png" alt="[ImageMagick]"
49 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
50<a href="http://www.networkredux.com">
51 <img src="../../images/networkredux.png" alt="[sponsor]"
52 style="margin: 45px auto; border: 0px; float: left;" /></a>
53<a href="http://www.imagemagick.org/discourse-server/">
54 <img src="../../images/logo.jpg" alt=""
55 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
56<a href="../../index.html">
57 <img src="../../images/sprite.jpg" alt=""
58 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
59</div>
60
cristyce69bb02010-07-27 19:49:46 +000061<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000062
cristy3ed852e2009-09-05 21:47:34 +000063<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000064 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000065</div>
cristy3eaa0ef2010-03-06 20:35:26 +000066<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000067<div class="menu">
cristybb503372010-05-27 20:51:26 +000068 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
69</div>
70<div class="sub">
71 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
78</div>
79<div class="sep"></div>
80<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000081 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000082</div>
83<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
104<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000105 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000107<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
111<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000116 </div>
117<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000118 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000119</div>
cristybb503372010-05-27 20:51:26 +0000120<div class="menu">
121 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
122</div>
cristy3ed852e2009-09-05 21:47:34 +0000123<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000124 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000125</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000126<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000128 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000129</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000130<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000131<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000132 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000133</div>
134<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000135 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000136</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000137<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000138<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000140
141<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000142<div class="sponsor">
143 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.html">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000144</div>
145<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000146 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
147</div>
148<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000149 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
150</div>
151<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000152 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000154<div class="sponsor">
155 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
156</div>
cristy3ed852e2009-09-05 21:47:34 +0000157</div>
158</div>
cristyce69bb02010-07-27 19:49:46 +0000159</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000160
cristyce69bb02010-07-27 19:49:46 +0000161<div class="eastbar">
162 <script type="text/javascript">
163 <!--
164 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000165 google_ad_slot = "0574824969";
166 google_ad_width = 160;
167 google_ad_height = 600;
168 //-->
169 </script>
170 <script type="text/javascript"
171 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
172 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000173</div>
174
175<div class="main">
176
cristy307ba182010-12-25 01:00:34 +0000177<h1>Module draw
178 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000179<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>
180
181<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
182_8c.html" target="source" name="AcquireDrawInfo">AcquireDrawInfo</a></h2>
183<div class="doc-section">
184
185<p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p></ol>
186
187<p>The format of the AcquireDrawInfo method is:</p>
188
189<pre class="code">
190 DrawInfo *AcquireDrawInfo(void)
191</pre>
192
193 </div>
194<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
195_8c.html" target="source" name="CloneDrawInfo">CloneDrawInfo</a></h2>
196<div class="doc-section">
197
198<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>
199
200<p>The format of the CloneDrawInfo method is:</p>
201
202<pre class="code">
203 DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
204 const DrawInfo *draw_info)
205</pre>
206
207<p>A description of each parameter follows:</p></ol>
208
209<h5>image_info</h5>
210<ol><p>the image info.</p></ol>
211
212<h5>draw_info</h5>
213<ol><p>the draw info.</p></ol>
214
215 </div>
216<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
217_8c.html" target="source" name="DestroyDrawInfo">DestroyDrawInfo</a></h2>
218<div class="doc-section">
219
220<p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p></ol>
221
222<p>The format of the DestroyDrawInfo method is:</p>
223
224<pre class="code">
225 DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
226</pre>
227
228<p>A description of each parameter follows:</p></ol>
229
230<h5>draw_info</h5>
231<ol><p>the draw info.</p></ol>
232
233 </div>
234<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
235_8c.html" target="source" name="DrawAffineImage">DrawAffineImage</a></h2>
236<div class="doc-section">
237
238<p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p></ol>
239
240<p>The format of the DrawAffineImage method is:</p>
241
242<pre class="code">
243 MagickBooleanType DrawAffineImage(Image *image,const Image *source,
244 const AffineMatrix *affine)
245</pre>
246
247<p>A description of each parameter follows:</p></ol>
248
249<h5>image</h5>
250<ol><p>the image.</p></ol>
251
252<h5>source</h5>
253<ol><p>the source image.</p></ol>
254
255<h5>affine</h5>
256<ol><p>the affine transform.</p></ol>
257
258 </div>
259<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
260_8c.html" target="source" name="DrawClipPath">DrawClipPath</a></h2>
261<div class="doc-section">
262
263<p>DrawClipPath() draws the clip path on the image mask.</p></ol>
264
265<p>The format of the DrawClipPath method is:</p>
266
267<pre class="code">
268 MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
269 const char *name)
270</pre>
271
272<p>A description of each parameter follows:</p></ol>
273
274<h5>image</h5>
275<ol><p>the image.</p></ol>
276
277<h5>draw_info</h5>
278<ol><p>the draw info.</p></ol>
279
280<h5>name</h5>
281<ol><p>the name of the clip path.</p></ol>
282
283 </div>
284<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
285_8c.html" target="source" name="DrawImage">DrawImage</a></h2>
286<div class="doc-section">
287
288<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>
289
290<p>The format of the DrawImage method is:</p>
291
292<pre class="code">
293 MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info)
294</pre>
295
296<p>A description of each parameter follows:</p></ol>
297
298<h5>image</h5>
299<ol><p>the image.</p></ol>
300
301<h5>draw_info</h5>
302<ol><p>the draw info.</p></ol>
303
304 </div>
305<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
306_8c.html" target="source" name="DrawGradientImage">DrawGradientImage</a></h2>
307<div class="doc-section">
308
309<p>DrawGradientImage() draws a linear gradient on the image.</p></ol>
310
311<p>The format of the DrawGradientImage method is:</p>
312
313<pre class="code">
314 MagickBooleanType DrawGradientImage(Image *image,
315 const DrawInfo *draw_info)
316</pre>
317
318<p>A description of each parameter follows:</p></ol>
319
320<h5>image</h5>
321<ol><p>the image.</p></ol>
322
323<h5>_info</h5>
324<ol><p>the draw info.</p></ol>
325
326 </div>
327<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
328_8c.html" target="source" name="DrawPatternPath">DrawPatternPath</a></h2>
329<div class="doc-section">
330
331<p>DrawPatternPath() draws a pattern.</p></ol>
332
333<p>The format of the DrawPatternPath method is:</p>
334
335<pre class="code">
336 MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
337 const char *name,Image **pattern)
338</pre>
339
340<p>A description of each parameter follows:</p></ol>
341
342<h5>image</h5>
343<ol><p>the image.</p></ol>
344
345<h5>draw_info</h5>
346<ol><p>the draw info.</p></ol>
347
348<h5>name</h5>
349<ol><p>the pattern name.</p></ol>
350
351<h5>image</h5>
352<ol><p>the image.</p></ol>
353
354 </div>
355<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
356_8c.html" target="source" name="DrawPrimitive">DrawPrimitive</a></h2>
357<div class="doc-section">
358
359<p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p></ol>
360
361<p>The format of the DrawPrimitive method is:</p>
362
363<pre class="code">
364 MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
365 PrimitiveInfo *primitive_info)
366</pre>
367
368<p>A description of each parameter follows:</p></ol>
369
370<h5>image</h5>
371<ol><p>the image.</p></ol>
372
373<h5>draw_info</h5>
374<ol><p>the draw info.</p></ol>
375
376<h5>primitive_info</h5>
377<ol><p>Specifies a pointer to a PrimitiveInfo structure.</p></ol>
378
379 </div>
380<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
381_8c.html" target="source" name="GetAffineMatrix">GetAffineMatrix</a></h2>
382<div class="doc-section">
383
384<p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p></ol>
385
386<p>The format of the GetAffineMatrix method is:</p>
387
388<pre class="code">
389 void GetAffineMatrix(AffineMatrix *affine_matrix)
390</pre>
391
392<p>A description of each parameter follows:</p></ol>
393
394<h5>affine_matrix</h5>
395<ol><p>the affine matrix.</p></ol>
396
397 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000398
399</div>
400
401<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000402 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000403 <span id="linkbar-center">
404 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000405 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000406 </span>
407 <span id="linkbar-east">&nbsp;</span>
408 </div>
409 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000410 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000411 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
412 </div>
413 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000414 <script type="text/javascript">
415 var _gaq = _gaq || [];
416 _gaq.push(['_setAccount', 'UA-17690367-1']);
417 _gaq.push(['_trackPageview']);
418
419 (function() {
420 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
421 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
422 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
423 })();
424 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000425</body>
426</html>