1 2 3 4 5<!doctype html> 6<html lang="en"> 7<head> 8 <meta charset="utf-8" /> 9 <meta name="viewport" content="width=device-width, initial-scale=1" /> 10 <title>ImageMagick - MagickCore, C API: Draw on an Image</title> 11 <meta name="application-name" content="ImageMagick" /> 12 <meta name="description" content="Use ImageMagick® to create, edit, compose, and convert digital images. Resize an image, crop it, change its shades and colors, add captions, and more." /> 13 <meta name="application-url" content="https://imagemagick.org" /> 14 <meta name="generator" content="PHP" /> 15 <meta name="keywords" content="magickcore, c, api:, draw, on, an, image, image processing software" /> 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-2020 ImageMagick Studio LLC" /> 23 <meta name="distribution" content="Global" /> 24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" /> 25 <meta property='og:url' content='../../' /> 26 <meta property='og:title' content='ImageMagick' /> 27 <meta property='og:image' content='../../../images/logo.png' /> 28 <meta property='og:type' content='website' /> 29 <meta property='og:site_name' content='ImageMagick' /> 30 <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" /> 31 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> 32 <link href="draw.html" rel="canonical" /> 33 <link href="../../../images/wand.png" rel="icon" /> 34 <link href="../../../images/wand.ico" rel="shortcut icon" /> 35 <link href="../../assets/magick.css" rel="stylesheet" /> 36</head> 37<body> 38 <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top"> 39 <div class="container-fluid"> 40 <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a> 41 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation"> 42 <span class="navbar-toggler-icon"></span> 43 </button> 44 45 <div class="collapse navbar-collapse" id="magick-navbars"> 46 <ul class="navbar-nav me-auto mb-2 mb-md-0"> 47 <li class="nav-item"> 48 <a class="nav-link " href="../../www/index.html">Home</a> 49 </li> 50 <li class="nav-item"> 51 <a class="nav-link " href="../../www/download.html">Download</a> 52 </li> 53 <li class="nav-item"> 54 <a class="nav-link " href="../../www/command-line-tools.html">Tools</a> 55 </li> 56 <li class="nav-item"> 57 <a class="nav-link " href="../../www/command-line-processing.html">CLI</a> 58 </li> 59 <li class="nav-item"> 60 <a class="nav-link " href="../../www/develop.html">Develop</a> 61 </li> 62 <li class="nav-item"> 63 <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a> 64 </li> 65 <li class="nav-item"> 66 <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe> 67 </li> 68 </ul> 69 <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php"> 70 <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search"> 71 <button class="btn btn-outline-success" type="submit" name="sa">Search</button> 72 </form> 73 </div> 74 </div> 75 </nav> 76 77 <div class="container"> 78 <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script> 79 <ins class="adsbygoogle" 80 style="display:block" 81 data-ad-client="ca-pub-3129977114552745" 82 data-ad-slot="6345125851" 83 data-full-width-responsive="true" 84 data-ad-format="horizontal"></ins> 85 <script> 86 (adsbygoogle = window.adsbygoogle || []).push({}); 87 </script> 88 89 </div> 90 91 <main class="container"> 92 <div class="magick-template"> 93<div class="magick-header"> 94<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#DrawClippingMask">DrawClippingMask</a> • <a href="draw.html#DrawCompositeMask">DrawCompositeMask</a> • <a href="draw.html#DrawGradientImage">DrawGradientImage</a> • <a href="draw.html#DrawImage">DrawImage</a> • <a href="draw.html#DrawPatternPath">DrawPatternPath</a> • <a href="draw.html#DrawPrimitive">DrawPrimitive</a> • <a href="draw.html#GetAffineMatrix">GetAffineMatrix</a></p> 95 96<h2><a href="../../api/MagickCore/draw_8c.html" id="AcquireDrawInfo">AcquireDrawInfo</a></h2> 97 98<p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p> 99 100<p>The format of the AcquireDrawInfo method is:</p> 101 102<pre class="text"> 103DrawInfo *AcquireDrawInfo(void) 104</pre> 105 106<h2><a href="../../api/MagickCore/draw_8c.html" id="CloneDrawInfo">CloneDrawInfo</a></h2> 107 108<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> 109 110<p>The format of the CloneDrawInfo method is:</p> 111 112<pre class="text"> 113DrawInfo *CloneDrawInfo(const ImageInfo *image_info, 114 const DrawInfo *draw_info) 115</pre> 116 117<p>A description of each parameter follows:</p> 118 119<dd> 120</dd> 121 122<dd> </dd> 123<dl class="dl-horizontal"> 124<dt>image_info</dt> 125<dd>the image info. </dd> 126 127<dd> </dd> 128<dt>draw_info</dt> 129<dd>the draw info. </dd> 130 131<dd> </dd> 132</dl> 133<h2><a href="../../api/MagickCore/draw_8c.html" id="DestroyDrawInfo">DestroyDrawInfo</a></h2> 134 135<p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p> 136 137<p>The format of the DestroyDrawInfo method is:</p> 138 139<pre class="text"> 140DrawInfo *DestroyDrawInfo(DrawInfo *draw_info) 141</pre> 142 143<p>A description of each parameter follows:</p> 144 145<dd> 146</dd> 147 148<dd> </dd> 149<dl class="dl-horizontal"> 150<dt>draw_info</dt> 151<dd>the draw info. </dd> 152 153<dd> </dd> 154</dl> 155<h2><a href="../../api/MagickCore/draw_8c.html" id="DrawAffineImage">DrawAffineImage</a></h2> 156 157<p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p> 158 159<p>The format of the DrawAffineImage method is:</p> 160 161<pre class="text"> 162MagickBooleanType DrawAffineImage(Image *image,const Image *source, 163 const AffineMatrix *affine,ExceptionInfo *exception) 164</pre> 165 166<p>A description of each parameter follows:</p> 167 168<dd> 169</dd> 170 171<dd> </dd> 172<dl class="dl-horizontal"> 173<dt>image</dt> 174<dd>the image. </dd> 175 176<dd> </dd> 177<dt>source</dt> 178<dd>the source image. </dd> 179 180<dd> </dd> 181<dt>affine</dt> 182<dd>the affine transform. </dd> 183 184<dd> </dd> 185<dt>exception</dt> 186<dd>return any errors or warnings in this structure. </dd> 187 188<dd> </dd> 189</dl> 190<h2><a href="../../api/MagickCore/draw_8c.html" id="DrawClipPath">DrawClipPath</a></h2> 191 192<p>DrawClipPath() draws the clip path on the image mask.</p> 193 194<p>The format of the DrawClipPath method is:</p> 195 196<pre class="text"> 197MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info, 198 const char *id,ExceptionInfo *exception) 199</pre> 200 201<p>A description of each parameter follows:</p> 202 203<dd> 204</dd> 205 206<dd> </dd> 207<dl class="dl-horizontal"> 208<dt>image</dt> 209<dd>the image. </dd> 210 211<dd> </dd> 212<dt>draw_info</dt> 213<dd>the draw info. </dd> 214 215<dd> </dd> 216<dt>id</dt> 217<dd>the clip path id. </dd> 218 219<dd> </dd> 220<dt>exception</dt> 221<dd>return any errors or warnings in this structure. </dd> 222 223<dd> </dd> 224</dl> 225<h2><a href="../../api/MagickCore/draw_8c.html" id="DrawClippingMask">DrawClippingMask</a></h2> 226 227<p>DrawClippingMask() draws the clip path and returns it as an image clipping mask.</p> 228 229<p>The format of the DrawClippingMask method is:</p> 230 231<pre class="text"> 232Image *DrawClippingMask(Image *image,const DrawInfo *draw_info, 233 const char *id,const char *clip_path,ExceptionInfo *exception) 234</pre> 235 236<p>A description of each parameter follows:</p> 237 238<dd> 239</dd> 240 241<dd> </dd> 242<dl class="dl-horizontal"> 243<dt>image</dt> 244<dd>the image. </dd> 245 246<dd> </dd> 247<dt>draw_info</dt> 248<dd>the draw info. </dd> 249 250<dd> </dd> 251<dt>id</dt> 252<dd>the clip path id. </dd> 253 254<dd> </dd> 255<dt>clip_path</dt> 256<dd>the clip path. </dd> 257 258<dd> </dd> 259<dt>exception</dt> 260<dd>return any errors or warnings in this structure. </dd> 261 262<dd> </dd> 263</dl> 264<h2><a href="../../api/MagickCore/draw_8c.html" id="DrawCompositeMask">DrawCompositeMask</a></h2> 265 266<p>DrawCompositeMask() draws the mask path and returns it as an image mask.</p> 267 268<p>The format of the DrawCompositeMask method is:</p> 269 270<pre class="text"> 271Image *DrawCompositeMask(Image *image,const DrawInfo *draw_info, 272 const char *id,const char *mask_path,ExceptionInfo *exception) 273</pre> 274 275<p>A description of each parameter follows:</p> 276 277<dd> 278</dd> 279 280<dd> </dd> 281<dl class="dl-horizontal"> 282<dt>image</dt> 283<dd>the image. </dd> 284 285<dd> </dd> 286<dt>draw_info</dt> 287<dd>the draw info. </dd> 288 289<dd> </dd> 290<dt>id</dt> 291<dd>the mask path id. </dd> 292 293<dd> </dd> 294<dt>mask_path</dt> 295<dd>the mask path. </dd> 296 297<dd> </dd> 298<dt>exception</dt> 299<dd>return any errors or warnings in this structure. </dd> 300 301<dd> </dd> 302</dl> 303<h2><a href="../../api/MagickCore/draw_8c.html" id="DrawGradientImage">DrawGradientImage</a></h2> 304 305<p>DrawGradientImage() draws a linear gradient on the image.</p> 306 307<p>The format of the DrawGradientImage method is:</p> 308 309<pre class="text"> 310MagickBooleanType DrawGradientImage(Image *image, 311 const DrawInfo *draw_info,ExceptionInfo *exception) 312</pre> 313 314<p>A description of each parameter follows:</p> 315 316<dd> 317</dd> 318 319<dd> </dd> 320<dl class="dl-horizontal"> 321<dt>image</dt> 322<dd>the image. </dd> 323 324<dd> </dd> 325<dt>draw_info</dt> 326<dd>the draw info. </dd> 327 328<dd> </dd> 329<dt>exception</dt> 330<dd>return any errors or warnings in this structure. </dd> 331 332<dd> </dd> 333</dl> 334<h2><a href="../../api/MagickCore/draw_8c.html" id="DrawImage">DrawImage</a></h2> 335 336<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> 337 338<p>The format of the DrawImage method is:</p> 339 340<pre class="text"> 341MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info, 342 ExceptionInfo *exception) 343</pre> 344 345<p>A description of each parameter follows:</p> 346 347<dd> 348</dd> 349 350<dd> </dd> 351<dl class="dl-horizontal"> 352<dt>image</dt> 353<dd>the image. </dd> 354 355<dd> </dd> 356<dt>draw_info</dt> 357<dd>the draw info. </dd> 358 359<dd> </dd> 360<dt>exception</dt> 361<dd>return any errors or warnings in this structure. </dd> 362 363<dd> </dd> 364</dl> 365<h2><a href="../../api/MagickCore/draw_8c.html" id="DrawPatternPath">DrawPatternPath</a></h2> 366 367<p>DrawPatternPath() draws a pattern.</p> 368 369<p>The format of the DrawPatternPath method is:</p> 370 371<pre class="text"> 372MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info, 373 const char *name,Image **pattern,ExceptionInfo *exception) 374</pre> 375 376<p>A description of each parameter follows:</p> 377 378<dd> 379</dd> 380 381<dd> </dd> 382<dl class="dl-horizontal"> 383<dt>image</dt> 384<dd>the image. </dd> 385 386<dd> </dd> 387<dt>draw_info</dt> 388<dd>the draw info. </dd> 389 390<dd> </dd> 391<dt>name</dt> 392<dd>the pattern name. </dd> 393 394<dd> </dd> 395<dt>image</dt> 396<dd>the image. </dd> 397 398<dd> </dd> 399<dt>exception</dt> 400<dd>return any errors or warnings in this structure. </dd> 401 402<dd> </dd> 403</dl> 404<h2><a href="../../api/MagickCore/draw_8c.html" id="DrawPrimitive">DrawPrimitive</a></h2> 405 406<p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p> 407 408<p>The format of the DrawPrimitive method is:</p> 409 410<pre class="text"> 411MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info, 412 PrimitiveInfo *primitive_info,ExceptionInfo *exception) 413</pre> 414 415<p>A description of each parameter follows:</p> 416 417<dd> 418</dd> 419 420<dd> </dd> 421<dl class="dl-horizontal"> 422<dt>image</dt> 423<dd>the image. </dd> 424 425<dd> </dd> 426<dt>draw_info</dt> 427<dd>the draw info. </dd> 428 429<dd> </dd> 430<dt>primitive_info</dt> 431<dd>Specifies a pointer to a PrimitiveInfo structure. </dd> 432 433<dd> </dd> 434<dt>exception</dt> 435<dd>return any errors or warnings in this structure. </dd> 436 437<dd> </dd> 438</dl> 439<h2><a href="../../api/MagickCore/draw_8c.html" id="GetAffineMatrix">GetAffineMatrix</a></h2> 440 441<p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p> 442 443<p>The format of the GetAffineMatrix method is:</p> 444 445<pre class="text"> 446void GetAffineMatrix(AffineMatrix *affine_matrix) 447</pre> 448 449<p>A description of each parameter follows:</p> 450 451<dd> 452</dd> 453 454<dd> </dd> 455<dl class="dl-horizontal"> 456<dt>affine_matrix</dt> 457<dd>the affine matrix. </dd> 458 459<dd> </dd> 460</dl> 461</div> 462 </div> 463 </main><!-- /.container --> 464 <footer class="magick-footer"> 465 <div class="container-fluid"> 466 <a href="../../www/security-policy.html">Security</a> • 467 <a href="../../www/news.html">News</a> 468 469 <a href="draw.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a> 470 471 <a href="../../www/links.html">Related</a> • 472 <a href="../../www/sitemap.html">Sitemap</a> 473 <br/> 474 <a href="../../www/support.html">Sponsor</a> • 475 <a href="../../www/cite.html">Cite</a> • 476 <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • 477 <a href="../../www/contact.html">Contact Us</a> 478 <br/> 479 <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> • 480 <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 416.32" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path fill="currentColor" d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92"/></svg></a> 481 <br/> 482 <small>© 1999-2021 ImageMagick Studio LLC</small> 483 </div> 484 </footer> 485 486 <!-- Javascript assets --> 487 <script src="../../assets/magick.js" ></script> 488 </body> 489</html> 490
