]> granicus.if.org Git - imagemagick/blob - www/api/draw.html
(no commit message)
[imagemagick] / www / api / draw.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
4 <head>\r
5   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
8   <style type="text/css" media="all">\r
9     @import url("../../www/magick.css");\r
10   </style>\r
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"/>
25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26   <meta name="Distribution" content="Global"/>
27 </head>\r
28 \r
29 <body id="www-imagemagick-org">\r
30 <div class="titlebar">\r
31 <a href="../../index.html">\r
32   <img src="../../images/script.png" alt="[ImageMagick]"\r
33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
34 <a href="http://www.networkredux.com">\r
35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
37 <a href="http://www.imagemagick.org/discourse-server/">\r
38   <img src="../../images/logo.jpg" alt=""\r
39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
40 <a href="../../index.html">\r
41   <img src="../../images/sprite.jpg" alt=""\r
42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
43 </div>\r
44 \r
45 <div class="eastbar">\r
46 \r
47 <div class="menu">
48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
49 </div>
50 <div class="sep"></div>\r
51 <div class="menu">
52   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53 </div>
54 <div class="sub">
55     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56 </div>
57 <div class="sub">
58     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59 </div>
60 <div class="sub">
61     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62 </div>
63 <div class="sep"></div>\r
64 <div class="menu">
65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
66 </div>
67 <div class="sub">
68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
69 </div>
70 <div class="sub">
71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
72 </div>
73 <div class="sub">
74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
75 </div>
76 <div class="menu">
77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
78 </div>
79 <div class="sub">
80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
81 </div>
82 <div class="sub">
83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
84 </div>
85 <div class="sub">
86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
87 </div>
88 <div class="sub">
89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
90 </div>
91 <div class="sep"></div>\r
92 <div  class="menu">
93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
94 </div>
95 <div class="sub">
96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
97 </div>
98 <div class="sub">
99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
100  </div>
101 <div class="menu">
102   <a title="Resources" href="../../www/resources.html">Resources</a>
103 </div>
104 <div class="menu">
105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106 </div>
107 <div class="menu">
108   <a title="Download" href="../../www/download.html">Download</a>
109 </div>
110 <div class="sep"></div>\r
111 <div class="menu">
112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
113 </div>
114 <div class="sep"></div>\r
115 <div class="menu">
116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
117 </div>
118 <div  class="sub">
119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
120 </div>
121 <div class="sep"></div>\r
122 <div  class="menu">
123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
124
125 <div class="sponsbox">
126 <div  class="sponsor">
127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
128 </div>
129 <div  class="sponsor">
130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
131 </div>
132 <div  class="sponsor">
133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
134 </div>
135 <div  class="sponsor">
136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
137 </div>
138 <div  class="sponsor">
139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
140 </div>
141 <div  class="sponsor">
142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
143 </div>
144 <div  class="sponsor">
145    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
146 </div>
147 </div>
148 </div>
149 \r
150 \r
151 </div>\r
152 \r
153 <div class="main">\r
154 \r
155 <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>
156
157 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
158 _8c.html" target="source" name="AcquireDrawInfo">AcquireDrawInfo</a></h2>
159 <div class="doc-section">
160
161 <p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p></ol>
162
163 <p>The format of the AcquireDrawInfo method is:</p>
164
165 <pre class="code">
166   DrawInfo *AcquireDrawInfo(void)
167 </pre>
168
169  </div>
170 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
171 _8c.html" target="source" name="CloneDrawInfo">CloneDrawInfo</a></h2>
172 <div class="doc-section">
173
174 <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>
175
176 <p>The format of the CloneDrawInfo method is:</p>
177
178 <pre class="code">
179   DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
180     const DrawInfo *draw_info)
181 </pre>
182
183 <p>A description of each parameter follows:</p></ol>
184
185 <h5>image_info</h5>
186 <ol><p>the image info.</p></ol>
187
188 <h5>draw_info</h5>
189 <ol><p>the draw info.</p></ol>
190
191  </div>
192 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
193 _8c.html" target="source" name="DestroyDrawInfo">DestroyDrawInfo</a></h2>
194 <div class="doc-section">
195
196 <p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p></ol>
197
198 <p>The format of the DestroyDrawInfo method is:</p>
199
200 <pre class="code">
201   DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
202 </pre>
203
204 <p>A description of each parameter follows:</p></ol>
205
206 <h5>draw_info</h5>
207 <ol><p>the draw info.</p></ol>
208
209  </div>
210 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
211 _8c.html" target="source" name="DrawAffineImage">DrawAffineImage</a></h2>
212 <div class="doc-section">
213
214 <p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p></ol>
215
216 <p>The format of the DrawAffineImage method is:</p>
217
218 <pre class="code">
219   MagickBooleanType DrawAffineImage(Image *image,const Image *source,
220     const AffineMatrix *affine)
221 </pre>
222
223 <p>A description of each parameter follows:</p></ol>
224
225 <h5>image</h5>
226 <ol><p>the image.</p></ol>
227
228 <h5>source</h5>
229 <ol><p>the source image.</p></ol>
230
231 <h5>affine</h5>
232 <ol><p>the affine transform.</p></ol>
233
234  </div>
235 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
236 _8c.html" target="source" name="DrawClipPath">DrawClipPath</a></h2>
237 <div class="doc-section">
238
239 <p>DrawClipPath() draws the clip path on the image mask.</p></ol>
240
241 <p>The format of the DrawClipPath method is:</p>
242
243 <pre class="code">
244   MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
245     const char *name)
246 </pre>
247
248 <p>A description of each parameter follows:</p></ol>
249
250 <h5>image</h5>
251 <ol><p>the image.</p></ol>
252
253 <h5>draw_info</h5>
254 <ol><p>the draw info.</p></ol>
255
256 <h5>name</h5>
257 <ol><p>the name of the clip path.</p></ol>
258
259  </div>
260 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
261 _8c.html" target="source" name="DrawImage">DrawImage</a></h2>
262 <div class="doc-section">
263
264 <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>
265
266 <p>The format of the DrawImage method is:</p>
267
268 <pre class="code">
269   MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info)
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  </div>
281 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
282 _8c.html" target="source" name="DrawGradientImage">DrawGradientImage</a></h2>
283 <div class="doc-section">
284
285 <p>DrawGradientImage() draws a linear gradient on the image.</p></ol>
286
287 <p>The format of the DrawGradientImage method is:</p>
288
289 <pre class="code">
290   MagickBooleanType DrawGradientImage(Image *image,
291     const DrawInfo *draw_info)
292 </pre>
293
294 <p>A description of each parameter follows:</p></ol>
295
296 <h5>image</h5>
297 <ol><p>the image.</p></ol>
298
299 <h5>_info</h5>
300 <ol><p>the draw info.</p></ol>
301
302  </div>
303 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
304 _8c.html" target="source" name="DrawPatternPath">DrawPatternPath</a></h2>
305 <div class="doc-section">
306
307 <p>DrawPatternPath() draws a pattern.</p></ol>
308
309 <p>The format of the DrawPatternPath method is:</p>
310
311 <pre class="code">
312   MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
313     const char *name,Image **pattern)
314 </pre>
315
316 <p>A description of each parameter follows:</p></ol>
317
318 <h5>image</h5>
319 <ol><p>the image.</p></ol>
320
321 <h5>draw_info</h5>
322 <ol><p>the draw info.</p></ol>
323
324 <h5>name</h5>
325 <ol><p>the pattern name.</p></ol>
326
327 <h5>image</h5>
328 <ol><p>the image.</p></ol>
329
330  </div>
331 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
332 _8c.html" target="source" name="DrawPrimitive">DrawPrimitive</a></h2>
333 <div class="doc-section">
334
335 <p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p></ol>
336
337 <p>The format of the DrawPrimitive method is:</p>
338
339 <pre class="code">
340   MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
341     PrimitiveInfo *primitive_info)
342 </pre>
343
344 <p>A description of each parameter follows:</p></ol>
345
346 <h5>image</h5>
347 <ol><p>the image.</p></ol>
348
349 <h5>draw_info</h5>
350 <ol><p>the draw info.</p></ol>
351
352 <h5>primitive_info</h5>
353 <ol><p>Specifies a pointer to a PrimitiveInfo structure.</p></ol>
354
355  </div>
356 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
357 _8c.html" target="source" name="GetAffineMatrix">GetAffineMatrix</a></h2>
358 <div class="doc-section">
359
360 <p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p></ol>
361
362 <p>The format of the GetAffineMatrix method is:</p>
363
364 <pre class="code">
365   void GetAffineMatrix(AffineMatrix *affine_matrix)
366 </pre>
367
368 <p>A description of each parameter follows:</p></ol>
369
370 <h5>affine_matrix</h5>
371 <ol><p>the affine matrix.</p></ol>
372
373  </div>
374 \r
375 </div>\r
376 \r
377 <div id="linkbar">\r
378  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
379     <span id="linkbar-center">\r
380       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
381     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
382     </span>\r
383     <span id="linkbar-east">&nbsp;</span>\r
384   </div>\r
385   <div class="footer">\r
386     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
387     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
388   </div>\r
389   <div style="clear: both; margin: 0; width: 100%; "></div>\r
390 </body>\r
391 </html>\r