granicus.if.org Git - imagemagick/blob - www/api/composite.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: Composite 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:, composite, 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.buerodruck.de/stempel-service/index.html">Stempel bestellen</a><!-- 200910000035+ -->
 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="#CompositeImageChannel">CompositeImageChannel</a> &bull; <a href="#TextureImage">TextureImage</a>]</p>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite
 157 _8c.html" target="source" name="CompositeImageChannel">CompositeImageChannel</a></h2>
 158 <div class="doc-section">
 159
 160 <p>CompositeImageChannel() returns the second image composited onto the first at the specified offset, using the specified composite method.</p></ol>
 161
 162 <p>The format of the CompositeImageChannel method is:</p>
 163
 164 <pre class="code">
 165   MagickBooleanType CompositeImage(Image *image,
 166     const CompositeOperator compose,Image *composite_image,
 167     const long x_offset,const long y_offset)
 168   MagickBooleanType CompositeImageChannel(Image *image,
 169     const ChannelType channel,const CompositeOperator compose,
 170     Image *composite_image,const long x_offset,const long y_offset)
 171 </pre>
 172
 173 <p>A description of each parameter follows:</p></ol>
 174
 175 <h5>image</h5>
 176 <ol><p>the destination image, modified by he composition</p></ol>
 177
 178 <h5>channel</h5>
 179 <ol><p>the channel.</p></ol>
 180
 181 <h5>compose</h5>
 182 <ol><p>This operator affects how the composite is applied to the image.  The operators and how they are utilized are listed here http://www.w3.org/TR/SVG12/#compositing.</p></ol>
 183
 184 <h5>composite_image</h5>
 185 <ol><p>the composite (source) image.</p></ol>
 186
 187 <h5>x_offset</h5>
 188 <ol><p>the column offset of the composited image.</p></ol>
 189
 190 <h5>y_offset</h5>
 191 <ol><p>the row offset of the composited image.</p></ol>
 192
 193 <p>Extra Controls from Image meta-data in 'composite_image' (artifacts)</p></ol>
 194
 195 <p>o "compose:args" A string containing extra numerical arguments for specific compose methods, generally expressed as a 'geometry' or a comma separated list of numbers.</p></ol>
 196
 197 <p>Compose methods needing such arguments include "BlendCompositeOp" and "DisplaceCompositeOp".</p></ol>
 198
 199 <p>o "compose:outside-overlay" Modify how the composition is to effect areas not directly covered by the 'composite_image' at the offset given.  Normally this is dependant on the 'compose' method, especially Duff-Porter methods.</p></ol>
 200
 201 <p>If set to "false" then disable all normal handling of pixels not covered by the composite_image.  Typically used for repeated tiling of the composite_image by the calling API.</p></ol>
 202
 203 <p>Previous to IM v6.5.3-3  this was called "modify-outside-overlay"</p></ol>
 204
 205  </div>
 206 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite
 207 _8c.html" target="source" name="TextureImage">TextureImage</a></h2>
 208 <div class="doc-section">
 209
 210 <p>TextureImage() repeatedly tiles the texture image across and down the image canvas.</p></ol>
 211
 212 <p>The format of the TextureImage method is:</p>
 213
 214 <pre class="code">
 215   MagickBooleanType TextureImage(Image *image,const Image *texture)
 216 </pre>
 217
 218 <p>A description of each parameter follows:</p></ol>
 219
 220 <h5>image</h5>
 221 <ol><p>the image.</p></ol>
 222
 223 <h5>texture</h5>
 224 <ol><p>This image is the texture to layer on the background.</p></ol>
 225
 226  </div>
 227 \r
 228 </div>\r
 229 \r
 230 <div id="linkbar">\r
 231  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 232     <span id="linkbar-center">\r
 233       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 234       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 235     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 236     </span>\r
 237     <span id="linkbar-east">&nbsp;</span>\r
 238   </div>\r
 239   <div class="footer">\r
 240     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 241     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 242   </div>\r
 243   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 244 </body>\r
 245 </html>\r