granicus.if.org Git - imagemagick/blob - www/api/draw.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml: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   <title>ImageMagick: MagickCore, C API for ImageMagick: Draw on an Image</title>
   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="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
  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, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  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-2011 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"/>
  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"/>\r
  27   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  28   <style type="text/css" media="all">\r
  29     @import url("../../www/magick.css");\r
  30   </style>\r
  31   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  32   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  33   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  34   <script type="text/javascript">\r
  35     $(document).ready(function() {\r
  36       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  37         'transitionIn'  : 'elastic',\r
  38         'transitionOut' : 'elastic',\r
  39         'overlayShow'   : false,\r
  40         'opacity'       : true\r
  41       });\r
  42     });\r
  43   </script>\r
  44 </head>\r
  45 \r
  46 <body id="www-imagemagick-org">\r
  47 <div class="titlebar">\r
  48 <a href="../../index.html">\r
  49   <img src="../../images/script.png" alt="[ImageMagick]"\r
  50   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  51 <a href="http://www.networkredux.com">\r
  52   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  53   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
  54 <a href="http://www.imagemagick.org/discourse-server/">\r
  55   <img src="../../images/logo.jpg"\r
  56   alt="ImageMagick Logo"\r
  57   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  58 <a href="../../index.html">\r
  59   <img src="../../images/sprite.jpg"\r
  60   alt="ImageMagick Sprite"\r
  61   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  62 </div>\r
  63 \r
  64 <div class="westbar">\r
  65 \r
  66 <div class="menu">
  67   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  68 </div>
  69 <div class="sep"></div>\r
  70 <div class="menu">
  71   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  78 </div>
  79 <div class="sub">
  80     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  81 </div>
  82 <div class="sep"></div>\r
  83 <div class="menu">
  84   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  91 </div>
  92 <div class="sub">
  93     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  94 </div>
  95 <div class="menu">
  96   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 103 </div>
 104 <div class="sub">
 105     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 106 </div>
 107 <div class="sub">
 108     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div  class="menu">
 112    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 116 </div>
 117 <div class="sub">
 118     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 119  </div>
 120 <div class="menu">
 121   <a title="Resources" href="../../www/resources.html">Resources</a>
 122 </div>
 123 <div class="menu">
 124   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 125 </div>
 126 <div class="menu">
 127   <a title="Download" href="../../www/download.html">Download</a>
 128 </div>
 129 <div class="sep"></div>\r
 130 <div class="menu">
 131   <a title="Search" href="../../www/search.html">Search</a>
 132 </div>
 133 <div class="sep"></div>\r
 134 <div class="menu">
 135   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 136 </div>
 137 <div  class="sub">
 138   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 139 </div>
 140 <div class="sep"></div>\r
 141 <div  class="menu">
 142   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 143
 144 <div class="sponsbox">
 145 <div  class="sponsor">
 146   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 147 </div>
 148 <div  class="sponsor">
 149   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 150 </div>
 151 <div  class="sponsor">
 152   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
 153 </div>
 154 <div class="sponsor">
 155   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
 156 </div>
 157 <div  class="sponsor">
 158   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 159 </div>
 160 <div  class="sponsor">
 161   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 162 </div>
 163 <div  class="sponsor">
 164   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 165 </div>
 166 <div  class="sponsor">
 167    <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
 168 </div>
 169 </div>
 170 </div>
 171 </div>\r
 172 \r
 173 <div class="eastbar">\r
 174   <script type="text/javascript">\r
 175   <!--\r
 176     google_ad_client = "pub-3129977114552745";\r
 177     google_ad_slot = "0574824969";\r
 178     google_ad_width = 160;\r
 179     google_ad_height = 600;\r
 180   //-->\r
 181   </script>\r
 182   <script type="text/javascript"\r
 183     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 184   </script>\r
 185 </div>\r
 186 \r
 187 <div class="main">\r
 188 \r
 189 <h1>Module draw
 190  Methods</h1>
 191 <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>
 192
 193 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 194 _8c.html" id="AcquireDrawInfo">AcquireDrawInfo</a></h2>
 195 <div class="doc-section">
 196
 197 <p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p>
 198
 199 <p>The format of the AcquireDrawInfo method is:</p>
 200
 201 <pre class="code">
 202   DrawInfo *AcquireDrawInfo(void)
 203 </pre>
 204
 205  </div>
 206 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 207 _8c.html" id="CloneDrawInfo">CloneDrawInfo</a></h2>
 208 <div class="doc-section">
 209
 210 <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>
 211
 212 <p>The format of the CloneDrawInfo method is:</p>
 213
 214 <pre class="code">
 215   DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
 216     const DrawInfo *draw_info)
 217 </pre>
 218
 219 <p>A description of each parameter follows:</p>
 220
 221 <h5>image_info</h5>
 222 <p>the image info.</p>
 223
 224 <h5>draw_info</h5>
 225 <p>the draw info.</p>
 226
 227  </div>
 228 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 229 _8c.html" id="DestroyDrawInfo">DestroyDrawInfo</a></h2>
 230 <div class="doc-section">
 231
 232 <p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p>
 233
 234 <p>The format of the DestroyDrawInfo method is:</p>
 235
 236 <pre class="code">
 237   DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
 238 </pre>
 239
 240 <p>A description of each parameter follows:</p>
 241
 242 <h5>draw_info</h5>
 243 <p>the draw info.</p>
 244
 245  </div>
 246 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 247 _8c.html" id="DrawAffineImage">DrawAffineImage</a></h2>
 248 <div class="doc-section">
 249
 250 <p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p>
 251
 252 <p>The format of the DrawAffineImage method is:</p>
 253
 254 <pre class="code">
 255   MagickBooleanType DrawAffineImage(Image *image,const Image *source,
 256     const AffineMatrix *affine)
 257 </pre>
 258
 259 <p>A description of each parameter follows:</p>
 260
 261 <h5>image</h5>
 262 <p>the image.</p>
 263
 264 <h5>source</h5>
 265 <p>the source image.</p>
 266
 267 <h5>affine</h5>
 268 <p>the affine transform.</p>
 269
 270  </div>
 271 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 272 _8c.html" id="DrawClipPath">DrawClipPath</a></h2>
 273 <div class="doc-section">
 274
 275 <p>DrawClipPath() draws the clip path on the image mask.</p>
 276
 277 <p>The format of the DrawClipPath method is:</p>
 278
 279 <pre class="code">
 280   MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
 281     const char *name)
 282 </pre>
 283
 284 <p>A description of each parameter follows:</p>
 285
 286 <h5>image</h5>
 287 <p>the image.</p>
 288
 289 <h5>draw_info</h5>
 290 <p>the draw info.</p>
 291
 292 <h5>name</h5>
 293 <p>the name of the clip path.</p>
 294
 295  </div>
 296 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 297 _8c.html" id="DrawImage">DrawImage</a></h2>
 298 <div class="doc-section">
 299
 300 <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>
 301
 302 <p>The format of the DrawImage method is:</p>
 303
 304 <pre class="code">
 305   MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info)
 306 </pre>
 307
 308 <p>A description of each parameter follows:</p>
 309
 310 <h5>image</h5>
 311 <p>the image.</p>
 312
 313 <h5>draw_info</h5>
 314 <p>the draw info.</p>
 315
 316  </div>
 317 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 318 _8c.html" id="DrawGradientImage">DrawGradientImage</a></h2>
 319 <div class="doc-section">
 320
 321 <p>DrawGradientImage() draws a linear gradient on the image.</p>
 322
 323 <p>The format of the DrawGradientImage method is:</p>
 324
 325 <pre class="code">
 326   MagickBooleanType DrawGradientImage(Image *image,
 327     const DrawInfo *draw_info)
 328 </pre>
 329
 330 <p>A description of each parameter follows:</p>
 331
 332 <h5>image</h5>
 333 <p>the image.</p>
 334
 335 <h5>_info</h5>
 336 <p>the draw info.</p>
 337
 338  </div>
 339 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 340 _8c.html" id="DrawPatternPath">DrawPatternPath</a></h2>
 341 <div class="doc-section">
 342
 343 <p>DrawPatternPath() draws a pattern.</p>
 344
 345 <p>The format of the DrawPatternPath method is:</p>
 346
 347 <pre class="code">
 348   MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
 349     const char *name,Image **pattern)
 350 </pre>
 351
 352 <p>A description of each parameter follows:</p>
 353
 354 <h5>image</h5>
 355 <p>the image.</p>
 356
 357 <h5>draw_info</h5>
 358 <p>the draw info.</p>
 359
 360 <h5>name</h5>
 361 <p>the pattern name.</p>
 362
 363 <h5>image</h5>
 364 <p>the image.</p>
 365
 366  </div>
 367 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 368 _8c.html" id="DrawPrimitive">DrawPrimitive</a></h2>
 369 <div class="doc-section">
 370
 371 <p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p>
 372
 373 <p>The format of the DrawPrimitive method is:</p>
 374
 375 <pre class="code">
 376   MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
 377     PrimitiveInfo *primitive_info)
 378 </pre>
 379
 380 <p>A description of each parameter follows:</p>
 381
 382 <h5>image</h5>
 383 <p>the image.</p>
 384
 385 <h5>draw_info</h5>
 386 <p>the draw info.</p>
 387
 388 <h5>primitive_info</h5>
 389 <p>Specifies a pointer to a PrimitiveInfo structure.</p>
 390
 391  </div>
 392 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 393 _8c.html" id="GetAffineMatrix">GetAffineMatrix</a></h2>
 394 <div class="doc-section">
 395
 396 <p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p>
 397
 398 <p>The format of the GetAffineMatrix method is:</p>
 399
 400 <pre class="code">
 401   void GetAffineMatrix(AffineMatrix *affine_matrix)
 402 </pre>
 403
 404 <p>A description of each parameter follows:</p>
 405
 406 <h5>affine_matrix</h5>
 407 <p>the affine matrix.</p>
 408
 409  </div>
 410 \r
 411 </div>\r
 412 \r
 413 <div id="linkbar">\r
 414     <span id="linkbar-west">&nbsp;</span>\r
 415     <span id="linkbar-center">\r
 416       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 417       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 418     </span>\r
 419     <span id="linkbar-east">&nbsp;</span>\r
 420   </div>\r
 421   <div class="footer">\r
 422     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 423     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 424   </div>\r
 425   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 426   <script type="text/javascript">\r
 427     var _gaq = _gaq || [];\r
 428     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 429     _gaq.push(['_trackPageview']);\r
 430 \r
 431     (function() {\r
 432       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 433       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 434       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 435     })();\r
 436   </script>\r
 437 </body>\r
 438 </html>\r