Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3ed852eea50f9d4cd633efb8c2b054b8e33c2530 / . / www / api / draw.html
blob: ccd67cb12abf0d7aef4d75825730b72ae0a112aa [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: Draw on 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:, draw, on, 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="#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>
149
150<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
151_8c.html" target="source" name="AcquireDrawInfo">AcquireDrawInfo</a></h2>
152<div class="doc-section">
153
154<p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p></ol>
155
156<p>The format of the AcquireDrawInfo method is:</p>
157
158<pre class="code">
159 DrawInfo *AcquireDrawInfo(void)
160</pre>
161
162 </div>
163<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
164_8c.html" target="source" name="CloneDrawInfo">CloneDrawInfo</a></h2>
165<div class="doc-section">
166
167<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>
168
169<p>The format of the CloneDrawInfo method is:</p>
170
171<pre class="code">
172 DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
173 const DrawInfo *draw_info)
174</pre>
175
176<p>A description of each parameter follows:</p></ol>
177
178<h5>image_info</h5>
179<ol><p>the image info.</p></ol>
180
181<h5>draw_info</h5>
182<ol><p>the draw info.</p></ol>
183
184 </div>
185<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
186_8c.html" target="source" name="DestroyDrawInfo">DestroyDrawInfo</a></h2>
187<div class="doc-section">
188
189<p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p></ol>
190
191<p>The format of the DestroyDrawInfo method is:</p>
192
193<pre class="code">
194 DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
195</pre>
196
197<p>A description of each parameter follows:</p></ol>
198
199<h5>draw_info</h5>
200<ol><p>the draw info.</p></ol>
201
202 </div>
203<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
204_8c.html" target="source" name="DrawAffineImage">DrawAffineImage</a></h2>
205<div class="doc-section">
206
207<p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p></ol>
208
209<p>The format of the DrawAffineImage method is:</p>
210
211<pre class="code">
212 MagickBooleanType DrawAffineImage(Image *image,const Image *source,
213 const AffineMatrix *affine)
214</pre>
215
216<p>A description of each parameter follows:</p></ol>
217
218<h5>image</h5>
219<ol><p>the image.</p></ol>
220
221<h5>source</h5>
222<ol><p>the source image.</p></ol>
223
224<h5>affine</h5>
225<ol><p>the affine transform.</p></ol>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
229_8c.html" target="source" name="DrawClipPath">DrawClipPath</a></h2>
230<div class="doc-section">
231
232<p>DrawClipPath() draws the clip path on the image mask.</p></ol>
233
234<p>The format of the DrawClipPath method is:</p>
235
236<pre class="code">
237 MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
238 const char *name)
239</pre>
240
241<p>A description of each parameter follows:</p></ol>
242
243<h5>image</h5>
244<ol><p>the image.</p></ol>
245
246<h5>draw_info</h5>
247<ol><p>the draw info.</p></ol>
248
249<h5>name</h5>
250<ol><p>the name of the clip path.</p></ol>
251
252 </div>
253<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
254_8c.html" target="source" name="DrawImage">DrawImage</a></h2>
255<div class="doc-section">
256
257<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>
258
259<p>The format of the DrawImage method is:</p>
260
261<pre class="code">
262 MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info)
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 </div>
274<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
275_8c.html" target="source" name="DrawGradientImage">DrawGradientImage</a></h2>
276<div class="doc-section">
277
278<p>DrawGradientImage() draws a linear gradient on the image.</p></ol>
279
280<p>The format of the DrawGradientImage method is:</p>
281
282<pre class="code">
283 MagickBooleanType DrawGradientImage(Image *image,
284 const DrawInfo *draw_info)
285</pre>
286
287<p>A description of each parameter follows:</p></ol>
288
289<h5>image</h5>
290<ol><p>the image.</p></ol>
291
292<h5>_info</h5>
293<ol><p>the draw info.</p></ol>
294
295 </div>
296<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
297_8c.html" target="source" name="DrawPatternPath">DrawPatternPath</a></h2>
298<div class="doc-section">
299
300<p>DrawPatternPath() draws a pattern.</p></ol>
301
302<p>The format of the DrawPatternPath method is:</p>
303
304<pre class="code">
305 MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
306 const char *name,Image **pattern)
307</pre>
308
309<p>A description of each parameter follows:</p></ol>
310
311<h5>image</h5>
312<ol><p>the image.</p></ol>
313
314<h5>draw_info</h5>
315<ol><p>the draw info.</p></ol>
316
317<h5>name</h5>
318<ol><p>the pattern name.</p></ol>
319
320<h5>image</h5>
321<ol><p>the image.</p></ol>
322
323 </div>
324<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
325_8c.html" target="source" name="DrawPrimitive">DrawPrimitive</a></h2>
326<div class="doc-section">
327
328<p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p></ol>
329
330<p>The format of the DrawPrimitive method is:</p>
331
332<pre class="code">
333 MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
334 PrimitiveInfo *primitive_info)
335</pre>
336
337<p>A description of each parameter follows:</p></ol>
338
339<h5>image</h5>
340<ol><p>the image.</p></ol>
341
342<h5>draw_info</h5>
343<ol><p>the draw info.</p></ol>
344
345<h5>primitive_info</h5>
346<ol><p>Specifies a pointer to a PrimitiveInfo structure.</p></ol>
347
348 </div>
349<h2><a href="http://www.imagemagick.org/api/MagickCore/draw
350_8c.html" target="source" name="GetAffineMatrix">GetAffineMatrix</a></h2>
351<div class="doc-section">
352
353<p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p></ol>
354
355<p>The format of the GetAffineMatrix method is:</p>
356
357<pre class="code">
358 void GetAffineMatrix(AffineMatrix *affine_matrix)
359</pre>
360
361<p>A description of each parameter follows:</p></ol>
362
363<h5>affine_matrix</h5>
364<ol><p>the affine matrix.</p></ol>
365
366 </div>
367
368</div>
369
370<div id="linkbar">
371 <!-- <span id="linkbar-west">&nbsp;</span> -->
372 <span id="linkbar-center">
373 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
374 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
375 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
376 </span>
377 <span id="linkbar-east">&nbsp;</span>
378 </div>
379 <div class="footer">
380 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
381 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
382 </div>
383 <div style="clear: both; margin: 0; width: 100%; "></div>
384</body>
385</html>