blob: 38de95b9572617ae0756237ee751489b0fba5e10 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" 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"/>
cristyffb69ed2010-12-25 00:06:48 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose 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"/>
cristy3c98a4f2010-08-13 20:09:41 +000024 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <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>
cristy3eaa0ef2010-03-06 20:35:26 +000030</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +000048<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000049
cristy3ed852e2009-09-05 21:47:34 +000050<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000051 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000052</div>
cristy3eaa0ef2010-03-06 20:35:26 +000053<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristybb503372010-05-27 20:51:26 +000055 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
cristy3eaa0ef2010-03-06 20:35:26 +000094<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000095<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristybb503372010-05-27 20:51:26 +0000107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000127
128<div class="sponsbox">
129<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000130 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristy5c4585b2010-11-11 00:13:57 +0000131</div>
132<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy0391e8d2010-04-10 01:36:10 +0000143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristyc1c61662009-09-30 14:04:37 +0000149</div>
cristy3ed852e2009-09-05 21:47:34 +0000150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000153
cristyce69bb02010-07-27 19:49:46 +0000154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000166</div>
167
168<div class="main">
169
cristy307ba182010-12-25 01:00:34 +0000170<h1>Module draw
171 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000172<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>
173
174<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
175_8c.html" target="source" name="AcquireDrawInfo">AcquireDrawInfo</a></h2>
176<div class="doc-section">
177
178<p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p></ol>
179
180<p>The format of the AcquireDrawInfo method is:</p>
181
182<pre class="code">
183 DrawInfo *AcquireDrawInfo(void)
184</pre>
185
186 </div>
187<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
188_8c.html" target="source" name="CloneDrawInfo">CloneDrawInfo</a></h2>
189<div class="doc-section">
190
191<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>
192
193<p>The format of the CloneDrawInfo method is:</p>
194
195<pre class="code">
196 DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
197 const DrawInfo *draw_info)
198</pre>
199
200<p>A description of each parameter follows:</p></ol>
201
202<h5>image_info</h5>
203<ol><p>the image info.</p></ol>
204
205<h5>draw_info</h5>
206<ol><p>the draw info.</p></ol>
207
208 </div>
209<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
210_8c.html" target="source" name="DestroyDrawInfo">DestroyDrawInfo</a></h2>
211<div class="doc-section">
212
213<p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p></ol>
214
215<p>The format of the DestroyDrawInfo method is:</p>
216
217<pre class="code">
218 DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
219</pre>
220
221<p>A description of each parameter follows:</p></ol>
222
223<h5>draw_info</h5>
224<ol><p>the draw info.</p></ol>
225
226 </div>
227<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
228_8c.html" target="source" name="DrawAffineImage">DrawAffineImage</a></h2>
229<div class="doc-section">
230
231<p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p></ol>
232
233<p>The format of the DrawAffineImage method is:</p>
234
235<pre class="code">
236 MagickBooleanType DrawAffineImage(Image *image,const Image *source,
237 const AffineMatrix *affine)
238</pre>
239
240<p>A description of each parameter follows:</p></ol>
241
242<h5>image</h5>
243<ol><p>the image.</p></ol>
244
245<h5>source</h5>
246<ol><p>the source image.</p></ol>
247
248<h5>affine</h5>
249<ol><p>the affine transform.</p></ol>
250
251 </div>
252<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
253_8c.html" target="source" name="DrawClipPath">DrawClipPath</a></h2>
254<div class="doc-section">
255
256<p>DrawClipPath() draws the clip path on the image mask.</p></ol>
257
258<p>The format of the DrawClipPath method is:</p>
259
260<pre class="code">
261 MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
262 const char *name)
263</pre>
264
265<p>A description of each parameter follows:</p></ol>
266
267<h5>image</h5>
268<ol><p>the image.</p></ol>
269
270<h5>draw_info</h5>
271<ol><p>the draw info.</p></ol>
272
273<h5>name</h5>
274<ol><p>the name of the clip path.</p></ol>
275
276 </div>
277<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
278_8c.html" target="source" name="DrawImage">DrawImage</a></h2>
279<div class="doc-section">
280
281<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>
282
283<p>The format of the DrawImage method is:</p>
284
285<pre class="code">
286 MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info)
287</pre>
288
289<p>A description of each parameter follows:</p></ol>
290
291<h5>image</h5>
292<ol><p>the image.</p></ol>
293
294<h5>draw_info</h5>
295<ol><p>the draw info.</p></ol>
296
297 </div>
298<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
299_8c.html" target="source" name="DrawGradientImage">DrawGradientImage</a></h2>
300<div class="doc-section">
301
302<p>DrawGradientImage() draws a linear gradient on the image.</p></ol>
303
304<p>The format of the DrawGradientImage method is:</p>
305
306<pre class="code">
307 MagickBooleanType DrawGradientImage(Image *image,
308 const DrawInfo *draw_info)
309</pre>
310
311<p>A description of each parameter follows:</p></ol>
312
313<h5>image</h5>
314<ol><p>the image.</p></ol>
315
316<h5>_info</h5>
317<ol><p>the draw info.</p></ol>
318
319 </div>
320<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
321_8c.html" target="source" name="DrawPatternPath">DrawPatternPath</a></h2>
322<div class="doc-section">
323
324<p>DrawPatternPath() draws a pattern.</p></ol>
325
326<p>The format of the DrawPatternPath method is:</p>
327
328<pre class="code">
329 MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
330 const char *name,Image **pattern)
331</pre>
332
333<p>A description of each parameter follows:</p></ol>
334
335<h5>image</h5>
336<ol><p>the image.</p></ol>
337
338<h5>draw_info</h5>
339<ol><p>the draw info.</p></ol>
340
341<h5>name</h5>
342<ol><p>the pattern name.</p></ol>
343
344<h5>image</h5>
345<ol><p>the image.</p></ol>
346
347 </div>
348<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
349_8c.html" target="source" name="DrawPrimitive">DrawPrimitive</a></h2>
350<div class="doc-section">
351
352<p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p></ol>
353
354<p>The format of the DrawPrimitive method is:</p>
355
356<pre class="code">
357 MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
358 PrimitiveInfo *primitive_info)
359</pre>
360
361<p>A description of each parameter follows:</p></ol>
362
363<h5>image</h5>
364<ol><p>the image.</p></ol>
365
366<h5>draw_info</h5>
367<ol><p>the draw info.</p></ol>
368
369<h5>primitive_info</h5>
370<ol><p>Specifies a pointer to a PrimitiveInfo structure.</p></ol>
371
372 </div>
373<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
374_8c.html" target="source" name="GetAffineMatrix">GetAffineMatrix</a></h2>
375<div class="doc-section">
376
377<p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p></ol>
378
379<p>The format of the GetAffineMatrix method is:</p>
380
381<pre class="code">
382 void GetAffineMatrix(AffineMatrix *affine_matrix)
383</pre>
384
385<p>A description of each parameter follows:</p></ol>
386
387<h5>affine_matrix</h5>
388<ol><p>the affine matrix.</p></ol>
389
390 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000391
392</div>
393
394<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000395 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000396 <span id="linkbar-center">
397 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000398 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000399 </span>
400 <span id="linkbar-east">&nbsp;</span>
401 </div>
402 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000403 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000404 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
405 </div>
406 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000407 <script type="text/javascript">
408 var _gaq = _gaq || [];
409 _gaq.push(['_setAccount', 'UA-17690367-1']);
410 _gaq.push(['_trackPageview']);
411
412 (function() {
413 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
414 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
415 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
416 })();
417 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000418</body>
419</html>