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" 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   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="all">\r
   9     @import url("../../www/magick.css");\r
  10   </style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Composite an Image</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <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"/>
  18   <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."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a title="Resources" href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a title="Download" href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Lampe Berger" href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <p class="navigation-index">[<a href="#CompositeImageChannel">CompositeImageChannel</a> &bull; <a href="#TextureImage">TextureImage</a>]</p>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite
 158 _8c.html" target="source" name="CompositeImageChannel">CompositeImageChannel</a></h2>
 159 <div class="doc-section">
 160
 161 <p>CompositeImageChannel() returns the second image composited onto the first at the specified offset, using the specified composite method.</p></ol>
 162
 163 <p>The format of the CompositeImageChannel method is:</p>
 164
 165 <pre class="code">
 166   MagickBooleanType CompositeImage(Image *image,
 167     const CompositeOperator compose,Image *composite_image,
 168     const long x_offset,const long y_offset)
 169   MagickBooleanType CompositeImageChannel(Image *image,
 170     const ChannelType channel,const CompositeOperator compose,
 171     Image *composite_image,const long x_offset,const long y_offset)
 172 </pre>
 173
 174 <p>A description of each parameter follows:</p></ol>
 175
 176 <h5>image</h5>
 177 <ol><p>the destination image, modified by he composition</p></ol>
 178
 179 <h5>channel</h5>
 180 <ol><p>the channel.</p></ol>
 181
 182 <h5>compose</h5>
 183 <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>
 184
 185 <h5>composite_image</h5>
 186 <ol><p>the composite (source) image.</p></ol>
 187
 188 <h5>x_offset</h5>
 189 <ol><p>the column offset of the composited image.</p></ol>
 190
 191 <h5>y_offset</h5>
 192 <ol><p>the row offset of the composited image.</p></ol>
 193
 194 <p>Extra Controls from Image meta-data in 'composite_image' (artifacts)</p></ol>
 195
 196 <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>
 197
 198 <p>Compose methods needing such arguments include "BlendCompositeOp" and "DisplaceCompositeOp".</p></ol>
 199
 200 <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>
 201
 202 <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>
 203
 204 <p>Previous to IM v6.5.3-3  this was called "modify-outside-overlay"</p></ol>
 205
 206  </div>
 207 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite
 208 _8c.html" target="source" name="TextureImage">TextureImage</a></h2>
 209 <div class="doc-section">
 210
 211 <p>TextureImage() repeatedly tiles the texture image across and down the image canvas.</p></ol>
 212
 213 <p>The format of the TextureImage method is:</p>
 214
 215 <pre class="code">
 216   MagickBooleanType TextureImage(Image *image,const Image *texture)
 217 </pre>
 218
 219 <p>A description of each parameter follows:</p></ol>
 220
 221 <h5>image</h5>
 222 <ol><p>the image.</p></ol>
 223
 224 <h5>texture</h5>
 225 <ol><p>This image is the texture to layer on the background.</p></ol>
 226
 227  </div>
 228 \r
 229 </div>\r
 230 \r
 231 <div id="linkbar">\r
 232  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 233     <span id="linkbar-center">\r
 234       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</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-2010 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