Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 44443b9be690ffb2fb66ae9298ad552639994ac0 / . / www / api / draw.html
blob: d480503936c4c8032572c0f27f07ac3ae7594206 [file] [log] [blame]
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Draw on an Image</title>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]8 <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">
11 <meta name="application-name" content="ImageMagick">
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, draw, on, an, image, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
16 <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">
22 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC">
23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
25 <link rel="icon" href="../../images/wand.png">
26 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon">
27 <link rel="stylesheet" href="css/bootstrap.min.css">
28 <link rel="stylesheet" href="css/magick.css">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]29</head>
30
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]31<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]33<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
46 <a class="magick-nav-item " href="../../index.html">Home</a>
47 <a class="magick-nav-item " href="../../www/binary-releases.html">Downloads</a>
48 <a class="magick-nav-item " href="../../www/command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../../www/command-line-options.html">Options</a>
50 <a class="magick-nav-item " href="../../www/api.html">Development</a>
51 <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
52 <a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a>
53 </nav>
54 </div>
55</div>
56<div class="container">
57<p class="text-center"><a href="draw.html#AcquireDrawInfo">AcquireDrawInfo</a> • <a href="draw.html#CloneDrawInfo">CloneDrawInfo</a> • <a href="draw.html#DestroyDrawInfo">DestroyDrawInfo</a> • <a href="draw.html#DrawAffineImage">DrawAffineImage</a> • <a href="draw.html#DrawClipPath">DrawClipPath</a> • <a href="draw.html#DrawImage">DrawImage</a> • <a href="draw.html#DrawGradientImage">DrawGradientImage</a> • <a href="draw.html#DrawPatternPath">DrawPatternPath</a> • <a href="draw.html#DrawPrimitive">DrawPrimitive</a> • <a href="draw.html#GetAffineMatrix">GetAffineMatrix</a></p>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]58
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]59<div class="magick-header">
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]60<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="AcquireDrawInfo">AcquireDrawInfo</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]61
62<p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p>
63
64<p>The format of the AcquireDrawInfo method is:</p>
65
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]66<pre class="text">
67DrawInfo *AcquireDrawInfo(void)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]68</pre>
69
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]70<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="CloneDrawInfo">CloneDrawInfo</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]71
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]72<p>CloneDrawInfo() makes a copy of the given draw_info structure. If NULL is specified, a new DrawInfo structure is created initialized to default values.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]73
74<p>The format of the CloneDrawInfo method is:</p>
75
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]76<pre class="text">
77DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
78 const DrawInfo *draw_info)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]79</pre>
80
81<p>A description of each parameter follows:</p>
82
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]83<dd>
84</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]85
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]86<dd> </dd>
87<dl class="dl-horizontal">
88<dt>image_info</dt>
89<dd>the image info. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]90
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]91<dd> </dd>
92<dt>draw_info</dt>
93<dd>the draw info. </dd>
94
95<dd> </dd>
96</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]97<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="DestroyDrawInfo">DestroyDrawInfo</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]98
99<p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p>
100
101<p>The format of the DestroyDrawInfo method is:</p>
102
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]103<pre class="text">
104DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]105</pre>
106
107<p>A description of each parameter follows:</p>
108
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]109<dd>
110</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]111
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]112<dd> </dd>
113<dl class="dl-horizontal">
114<dt>draw_info</dt>
115<dd>the draw info. </dd>
116
117<dd> </dd>
118</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]119<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="DrawAffineImage">DrawAffineImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]120
121<p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p>
122
123<p>The format of the DrawAffineImage method is:</p>
124
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]125<pre class="text">
126MagickBooleanType DrawAffineImage(Image *image,const Image *source,
127 const AffineMatrix *affine,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]128</pre>
129
130<p>A description of each parameter follows:</p>
131
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]132<dd>
133</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]134
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]135<dd> </dd>
136<dl class="dl-horizontal">
137<dt>image</dt>
138<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]139
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]140<dd> </dd>
141<dt>source</dt>
142<dd>the source image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]143
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]144<dd> </dd>
145<dt>affine</dt>
146<dd>the affine transform. </dd>
147
148<dd> </dd>
149<dt>exception</dt>
150<dd>return any errors or warnings in this structure. </dd>
151
152<dd> </dd>
153</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]154<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="DrawClipPath">DrawClipPath</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]155
156<p>DrawClipPath() draws the clip path on the image mask.</p>
157
158<p>The format of the DrawClipPath method is:</p>
159
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]160<pre class="text">
161MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
162 const char *name,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]163</pre>
164
165<p>A description of each parameter follows:</p>
166
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]167<dd>
168</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]169
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]170<dd> </dd>
171<dl class="dl-horizontal">
172<dt>image</dt>
173<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]174
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]175<dd> </dd>
176<dt>draw_info</dt>
177<dd>the draw info. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]178
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]179<dd> </dd>
180<dt>name</dt>
181<dd>the name of the clip path. </dd>
182
183<dd> </dd>
184<dt>exception</dt>
185<dd>return any errors or warnings in this structure. </dd>
186
187<dd> </dd>
188</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]189<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="DrawImage">DrawImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]190
191<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>
192
193<p>The format of the DrawImage method is:</p>
194
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]195<pre class="text">
196MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info,
197 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]198</pre>
199
200<p>A description of each parameter follows:</p>
201
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]202<dd>
203</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]204
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]205<dd> </dd>
206<dl class="dl-horizontal">
207<dt>image</dt>
208<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]209
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]210<dd> </dd>
211<dt>draw_info</dt>
212<dd>the draw info. </dd>
213
214<dd> </dd>
215<dt>exception</dt>
216<dd>return any errors or warnings in this structure. </dd>
217
218<dd> </dd>
219</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]220<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="DrawGradientImage">DrawGradientImage</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]221
222<p>DrawGradientImage() draws a linear gradient on the image.</p>
223
224<p>The format of the DrawGradientImage method is:</p>
225
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]226<pre class="text">
227MagickBooleanType DrawGradientImage(Image *image,
228 const DrawInfo *draw_info,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]229</pre>
230
231<p>A description of each parameter follows:</p>
232
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]233<dd>
234</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]235
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]236<dd> </dd>
237<dl class="dl-horizontal">
238<dt>image</dt>
239<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]240
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]241<dd> </dd>
242<dt>draw_info</dt>
243<dd>the draw info. </dd>
244
245<dd> </dd>
246<dt>exception</dt>
247<dd>return any errors or warnings in this structure. </dd>
248
249<dd> </dd>
250</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]251<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="DrawPatternPath">DrawPatternPath</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]252
253<p>DrawPatternPath() draws a pattern.</p>
254
255<p>The format of the DrawPatternPath method is:</p>
256
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]257<pre class="text">
258MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
259 const char *name,Image **pattern,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]260</pre>
261
262<p>A description of each parameter follows:</p>
263
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]264<dd>
265</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]266
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]267<dd> </dd>
268<dl class="dl-horizontal">
269<dt>image</dt>
270<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]271
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]272<dd> </dd>
273<dt>draw_info</dt>
274<dd>the draw info. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]275
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]276<dd> </dd>
277<dt>name</dt>
278<dd>the pattern name. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]279
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]280<dd> </dd>
281<dt>image</dt>
282<dd>the image. </dd>
283
284<dd> </dd>
285<dt>exception</dt>
286<dd>return any errors or warnings in this structure. </dd>
287
288<dd> </dd>
289</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]290<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="DrawPrimitive">DrawPrimitive</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]291
292<p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p>
293
294<p>The format of the DrawPrimitive method is:</p>
295
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]296<pre class="text">
297MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
298 PrimitiveInfo *primitive_info,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]299</pre>
300
301<p>A description of each parameter follows:</p>
302
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]303<dd>
304</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]305
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]306<dd> </dd>
307<dl class="dl-horizontal">
308<dt>image</dt>
309<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]310
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]311<dd> </dd>
312<dt>draw_info</dt>
313<dd>the draw info. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]314
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]315<dd> </dd>
316<dt>primitive_info</dt>
317<dd>Specifies a pointer to a PrimitiveInfo structure. </dd>
318
319<dd> </dd>
320<dt>exception</dt>
321<dd>return any errors or warnings in this structure. </dd>
322
323<dd> </dd>
324</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]325<h2><a href="http://www.imagemagick.org/api/MagickCore/draw_8c.html" id="GetAffineMatrix">GetAffineMatrix</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]326
327<p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p>
328
329<p>The format of the GetAffineMatrix method is:</p>
330
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]331<pre class="text">
332void GetAffineMatrix(AffineMatrix *affine_matrix)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]333</pre>
334
335<p>A description of each parameter follows:</p>
336
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]337<dd>
338</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]339
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]340<dd> </dd>
341<dl class="dl-horizontal">
342<dt>affine_matrix</dt>
343<dd>the affine matrix. </dd>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]344
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]345<dd> </dd>
346</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]347</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]348 <footer class="magick-footer">
349 <div class="magick-nav-item navbar-left">
350 <a href="../../www/support.html">Donations</a>
351 </div>
352 <div class="magick-nav-item navbar-right">
353 <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a>
354 <noscript>
355 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
356 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
357 </noscript>
358 </div>
359 <p><a href="../../www/sitemap.html">Sitemap</a> •
360 <a href="../../www/links.html">Related</a> •
361 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
362 <a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
363 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
364</p>
365 <p><a href="draw.html#">Back to top</a> •
366 <a href="../../www/contact.html">Contact Us</a></p>
367 </footer>
368</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]369
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]370 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
371 <script src="../../js/bootstrap.min.js"></script>
372 <script type="text/javascript">
373 /* */
374 (function() {
375 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
376 s.type = 'text/javascript';
377 s.async = true;
378 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
379 t.parentNode.insertBefore(s, t);
380 })();
381 /* */
382 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]383</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]384</body>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]385</html><!-- Magick Cache 4th May 2015 18:57 -->