granicus.if.org Git - imagemagick/blob - www/api/composite.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: Composite 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:, composite, 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: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
 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 composite
 190  Methods</h1>
 191 <p class="navigation-index">[<a href="#CompositeImageChannel">CompositeImageChannel</a> &bull; <a href="#TextureImage">TextureImage</a>]</p>
 192
 193 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite
 194 _8c.html" id="CompositeImageChannel">CompositeImageChannel</a></h2>
 195 <div class="doc-section">
 196
 197 <p>CompositeImageChannel() returns the second image composited onto the first at the specified offset, using the specified composite method.</p>
 198
 199 <p>The format of the CompositeImageChannel method is:</p>
 200
 201 <pre class="code">
 202   MagickBooleanType CompositeImage(Image *image,
 203     const CompositeOperator compose,Image *composite_image,
 204     const ssize_t x_offset,const ssize_t y_offset)
 205   MagickBooleanType CompositeImageChannel(Image *image,
 206     const ChannelType channel,const CompositeOperator compose,
 207     Image *composite_image,const ssize_t x_offset,const ssize_t y_offset)
 208 </pre>
 209
 210 <p>A description of each parameter follows:</p>
 211
 212 <h5>image</h5>
 213 <p>the destination image, modified by he composition</p>
 214
 215 <h5>channel</h5>
 216 <p>the channel.</p>
 217
 218 <h5>compose</h5>
 219 <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>
 220
 221 <h5>composite_image</h5>
 222 <p>the composite (source) image.</p>
 223
 224 <h5>x_offset</h5>
 225 <p>the column offset of the composited image.</p>
 226
 227 <h5>y_offset</h5>
 228 <p>the row offset of the composited image.</p>
 229
 230 <p>Extra Controls from Image meta-data in 'composite_image' (artifacts)</p>
 231
 232 <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>
 233
 234 <p>Compose methods needing such arguments include "BlendCompositeOp" and "DisplaceCompositeOp".</p>
 235
 236 <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>
 237
 238 <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>
 239
 240 <p>Previous to IM v6.5.3-3  this was called "modify-outside-overlay"</p>
 241
 242  </div>
 243 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite
 244 _8c.html" id="TextureImage">TextureImage</a></h2>
 245 <div class="doc-section">
 246
 247 <p>TextureImage() repeatedly tiles the texture image across and down the image canvas.</p>
 248
 249 <p>The format of the TextureImage method is:</p>
 250
 251 <pre class="code">
 252   MagickBooleanType TextureImage(Image *image,const Image *texture)
 253 </pre>
 254
 255 <p>A description of each parameter follows:</p>
 256
 257 <h5>image</h5>
 258 <p>the image.</p>
 259
 260 <h5>texture</h5>
 261 <p>This image is the texture to layer on the background.</p>
 262
 263  </div>
 264 \r
 265 </div>\r
 266 \r
 267 <div id="linkbar">\r
 268     <span id="linkbar-west">&nbsp;</span>\r
 269     <span id="linkbar-center">\r
 270       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 271       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 272     </span>\r
 273     <span id="linkbar-east">&nbsp;</span>\r
 274   </div>\r
 275   <div class="footer">\r
 276     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 277     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 278   </div>\r
 279   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 280   <script type="text/javascript">\r
 281     var _gaq = _gaq || [];\r
 282     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 283     _gaq.push(['_trackPageview']);\r
 284 \r
 285     (function() {\r
 286       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 287       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 288       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 289     })();\r
 290   </script>\r
 291 </body>\r
 292 </html>\r