granicus.if.org Git - imagemagick/blob - 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">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  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>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  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>\r
  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>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 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>\r
 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.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <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>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 157 _8c.html" target="source" name="AcquireDrawInfo">AcquireDrawInfo</a></h2>
 158 <div class="doc-section">
 159
 160 <p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p></ol>
 161
 162 <p>The format of the AcquireDrawInfo method is:</p>
 163
 164 <pre class="code">
 165   DrawInfo *AcquireDrawInfo(void)
 166 </pre>
 167
 168  </div>
 169 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 170 _8c.html" target="source" name="CloneDrawInfo">CloneDrawInfo</a></h2>
 171 <div class="doc-section">
 172
 173 <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>
 174
 175 <p>The format of the CloneDrawInfo method is:</p>
 176
 177 <pre class="code">
 178   DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
 179     const DrawInfo *draw_info)
 180 </pre>
 181
 182 <p>A description of each parameter follows:</p></ol>
 183
 184 <h5>image_info</h5>
 185 <ol><p>the image info.</p></ol>
 186
 187 <h5>draw_info</h5>
 188 <ol><p>the draw info.</p></ol>
 189
 190  </div>
 191 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 192 _8c.html" target="source" name="DestroyDrawInfo">DestroyDrawInfo</a></h2>
 193 <div class="doc-section">
 194
 195 <p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p></ol>
 196
 197 <p>The format of the DestroyDrawInfo method is:</p>
 198
 199 <pre class="code">
 200   DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
 201 </pre>
 202
 203 <p>A description of each parameter follows:</p></ol>
 204
 205 <h5>draw_info</h5>
 206 <ol><p>the draw info.</p></ol>
 207
 208  </div>
 209 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 210 _8c.html" target="source" name="DrawAffineImage">DrawAffineImage</a></h2>
 211 <div class="doc-section">
 212
 213 <p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p></ol>
 214
 215 <p>The format of the DrawAffineImage method is:</p>
 216
 217 <pre class="code">
 218   MagickBooleanType DrawAffineImage(Image *image,const Image *source,
 219     const AffineMatrix *affine)
 220 </pre>
 221
 222 <p>A description of each parameter follows:</p></ol>
 223
 224 <h5>image</h5>
 225 <ol><p>the image.</p></ol>
 226
 227 <h5>source</h5>
 228 <ol><p>the source image.</p></ol>
 229
 230 <h5>affine</h5>
 231 <ol><p>the affine transform.</p></ol>
 232
 233  </div>
 234 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 235 _8c.html" target="source" name="DrawClipPath">DrawClipPath</a></h2>
 236 <div class="doc-section">
 237
 238 <p>DrawClipPath() draws the clip path on the image mask.</p></ol>
 239
 240 <p>The format of the DrawClipPath method is:</p>
 241
 242 <pre class="code">
 243   MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
 244     const char *name)
 245 </pre>
 246
 247 <p>A description of each parameter follows:</p></ol>
 248
 249 <h5>image</h5>
 250 <ol><p>the image.</p></ol>
 251
 252 <h5>draw_info</h5>
 253 <ol><p>the draw info.</p></ol>
 254
 255 <h5>name</h5>
 256 <ol><p>the name of the clip path.</p></ol>
 257
 258  </div>
 259 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 260 _8c.html" target="source" name="DrawImage">DrawImage</a></h2>
 261 <div class="doc-section">
 262
 263 <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>
 264
 265 <p>The format of the DrawImage method is:</p>
 266
 267 <pre class="code">
 268   MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info)
 269 </pre>
 270
 271 <p>A description of each parameter follows:</p></ol>
 272
 273 <h5>image</h5>
 274 <ol><p>the image.</p></ol>
 275
 276 <h5>draw_info</h5>
 277 <ol><p>the draw info.</p></ol>
 278
 279  </div>
 280 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 281 _8c.html" target="source" name="DrawGradientImage">DrawGradientImage</a></h2>
 282 <div class="doc-section">
 283
 284 <p>DrawGradientImage() draws a linear gradient on the image.</p></ol>
 285
 286 <p>The format of the DrawGradientImage method is:</p>
 287
 288 <pre class="code">
 289   MagickBooleanType DrawGradientImage(Image *image,
 290     const DrawInfo *draw_info)
 291 </pre>
 292
 293 <p>A description of each parameter follows:</p></ol>
 294
 295 <h5>image</h5>
 296 <ol><p>the image.</p></ol>
 297
 298 <h5>_info</h5>
 299 <ol><p>the draw info.</p></ol>
 300
 301  </div>
 302 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 303 _8c.html" target="source" name="DrawPatternPath">DrawPatternPath</a></h2>
 304 <div class="doc-section">
 305
 306 <p>DrawPatternPath() draws a pattern.</p></ol>
 307
 308 <p>The format of the DrawPatternPath method is:</p>
 309
 310 <pre class="code">
 311   MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
 312     const char *name,Image **pattern)
 313 </pre>
 314
 315 <p>A description of each parameter follows:</p></ol>
 316
 317 <h5>image</h5>
 318 <ol><p>the image.</p></ol>
 319
 320 <h5>draw_info</h5>
 321 <ol><p>the draw info.</p></ol>
 322
 323 <h5>name</h5>
 324 <ol><p>the pattern name.</p></ol>
 325
 326 <h5>image</h5>
 327 <ol><p>the image.</p></ol>
 328
 329  </div>
 330 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 331 _8c.html" target="source" name="DrawPrimitive">DrawPrimitive</a></h2>
 332 <div class="doc-section">
 333
 334 <p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p></ol>
 335
 336 <p>The format of the DrawPrimitive method is:</p>
 337
 338 <pre class="code">
 339   MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
 340     PrimitiveInfo *primitive_info)
 341 </pre>
 342
 343 <p>A description of each parameter follows:</p></ol>
 344
 345 <h5>image</h5>
 346 <ol><p>the image.</p></ol>
 347
 348 <h5>draw_info</h5>
 349 <ol><p>the draw info.</p></ol>
 350
 351 <h5>primitive_info</h5>
 352 <ol><p>Specifies a pointer to a PrimitiveInfo structure.</p></ol>
 353
 354  </div>
 355 <h2><a href="http://www.imagemagick.org/api/MagickCore/draw
 356 _8c.html" target="source" name="GetAffineMatrix">GetAffineMatrix</a></h2>
 357 <div class="doc-section">
 358
 359 <p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p></ol>
 360
 361 <p>The format of the GetAffineMatrix method is:</p>
 362
 363 <pre class="code">
 364   void GetAffineMatrix(AffineMatrix *affine_matrix)
 365 </pre>
 366
 367 <p>A description of each parameter follows:</p></ol>
 368
 369 <h5>affine_matrix</h5>
 370 <ol><p>the affine matrix.</p></ol>
 371
 372  </div>
 373 \r
 374 </div>\r
 375 \r
 376 <div id="linkbar">\r
 377  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 378     <span id="linkbar-center">\r
 379       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 380       <a href="../../www/mailing-list.html">Mailing Lists</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-2009 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