]> granicus.if.org Git - imagemagick/blob - www/api/composite.html
(no commit message)
[imagemagick] / 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 version="-//W3C//DTD XHTML 1.1//EN"\r
4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
8 <head>\r
9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>\r
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="Application-name" content="ImageMagick"/>
16   <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 automagically."/>
17   <meta name="Application-url" content="http://www.imagemagick.org"/>
18   <meta name="Generator" content="PHP"/>
19   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, composite, an, image, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
20   <meta name="Rating" content="GENERAL"/>
21   <meta name="Robots" content="INDEX, FOLLOW"/>
22   <meta name="Generator" content="ImageMagick Studio LLC"/>
23   <meta name="Author" content="ImageMagick Studio LLC"/>
24   <meta name="Revisit-after" content="2 DAYS"/>
25   <meta name="Resource-type" content="document"/>
26   <meta name="Copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
27   <meta name="Distribution" content="Global"/>
28   <link rel="icon" href="../../images/wand.png"/>
29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
30   <link rel="canonical" href="http://www.imagemagick.org" />\r
31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
32   <!-- Add jQuery library -->\r
33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>\r
34   \r
35   <!-- Optionaly include easing and/or mousewheel plugins -->\r
36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>\r
37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>\r
38   \r
39   <!-- Add fancyBox -->\r
40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.3" type="text/css" media="screen" />\r
41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.3"></script>\r
42   \r
43   <!-- Optionaly include button and/or thumbnail helpers -->\r
44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.3" type="text/css" media="screen" />\r
45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.3"></script>\r
46   \r
47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.3" type="text/css" media="screen" />\r
48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.3"></script>\r
49   <script type="text/javascript">\r
50         $(document).ready(function() {\r
51                 $(".fancybox").fancybox();\r
52         });\r
53   </script>\r
54   <!-- ImageMagick style -->\r
55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
56   <style type="text/css" media="all">\r
57     @import url("../../www/magick.css");\r
58   </style>\r
59 </head>\r
60 \r
61 <body id="www-imagemagick-org">\r
62 <div class="titlebar">\r
63 <div style="margin: 17px auto; float: left;">\r
64   <script type="text/javascript">\r
65   <!--\r
66     google_ad_client = "pub-3129977114552745";\r
67     google_ad_slot = "5439289906";\r
68     google_ad_width = 728;\r
69     google_ad_height = 90;\r
70   //-->\r
71   </script>\r
72   <script type="text/javascript"\r
73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
74   </script>\r
75 </div>\r
76 <a href="http://www.imagemagick.org/discourse-server/">\r
77   <img src="../../images/logo.jpg"\r
78   alt="ImageMagick Logo"\r
79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
80 <a href="../../index.html">\r
81   <img src="../../images/sprite.jpg"\r
82   alt="ImageMagick Sprite"\r
83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
84 </div>\r
85 \r
86 <div class="westbar">\r
87 \r
88 <div class="menu">
89   <a title="About ImageMagick" href="../../index.html">About ImageMagick</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: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
102 </div>
103 <div class="sub">
104     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
105 </div>
106 <div class="sep"></div>\r
107 <div class="menu">
108   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
109 </div>
110 <div class="sub">
111     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
112 </div>
113 <div class="sub">
114     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
115 </div>
116 <div class="sub">
117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
118 </div>
119 <div class="menu">
120   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
121 </div>
122 <div class="sub">
123     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
124 </div>
125 <div class="sub">
126     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
127 </div>
128 <div class="sub">
129     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
130 </div>
131 <div class="sub">
132     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
133 </div>
134 <div class="sep"></div>\r
135 <div  class="menu">
136    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
137 </div>
138 <div class="sub">
139     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
140 </div>
141 <div class="sub">
142     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
143  </div>
144 <div class="menu">
145   <a title="Resources" href="../../www/resources.html">Resources</a>
146 </div>
147 <div class="menu">
148   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
149 </div>
150 <div class="menu">
151   <a title="Download" href="../../www/download.html">Download</a>
152 </div>
153 <div class="sep"></div>\r
154 <div class="menu">
155   <a title="Search" href="../../www/search.html">Search</a>
156 </div>
157 <div class="sep"></div>\r
158 <div class="menu">
159   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
160 </div>
161 <div  class="sub">
162   <a title="Site Map: Links" href="../../www/links.html">Links</a>
163 </div>
164 <div class="sep"></div>\r
165 <div class="menu">
166   <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
167
168   <a href="http://www.networkredux.com"> <img src="../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201204010120 mickey@163... -->
170 <div class="sponsbox">
171 <div class="sponsor">
172   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201204010120 mickey@163... -->
173 </div>
174 <div class="sponsor">
175   <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
176 </div>
177 <div class="sponsor">
178   <a rel="follow" title="Sponsor: Autos Part" href="http://www.pkwteile.de/autoteile">Autos Part</a><!-- 201203010270 info@pkwte... -->
179 </div>
180 <div class="sponsor">
181   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
182 </div>
183 <div class="sponsor">
184   <a rel="follow" title="Sponsor: Tenant Check" href="http://www.rentmethod.com/">Tenant Check</a><!-- 201203010090 chris@rentm... -->
185 </div>
186 <div class="sponsor">
187   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201204010090 barsh@inter... -->
188 </div>
189 <div class="sponsor">
190    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
191 </div>
192 <div class="sponsor">
193   <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201301010090s jen@seo lowprofilelinks -->
194 </div>
195 <div class="sponsor">
196    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
197 </div>
198 <div class="sponsor">
199   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
200 </div>
201 <div class="sponsor">
202    <a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... -->
203 </div>
204 <div class="sponsor">
205   <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj -->
206 </div>
207 <div class="sponsor">
208    <a rel="follow" title="Sponsor: Royalty Free Stock Images" href="http://www.canstockphoto.com/">Royalty Free Stock Images</a><!-- 2012050100360 support@can -->
209 </div>
210 <div class="sponsor">
211   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
212 </div>
213 <div class="sponsor">
214   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
215 </div>
216 <div class="sponsor">
217    <a rel="follow" title="Sponsor: Turbolader Online kaufen" href="http://www.autoteile-carparts.de">Turbolader Online kaufen</a><!-- 2012050100150 t.temurbas...-->
218 </div>
219 <div class="sponsor">
220    <a rel="follow" title="Sponsor: Brand shopping" href="http://brandport.net">Brand shopping</a><!-- 20120201000150 gyaku@gyaku... -->
221 </div>
222 </div>
223 </div>
224 </div>\r
225 \r
226 <div class="eastbar">\r
227   <div class="g-plusone" data-size="standard" data-count="false"></div>\r
228   <script type="text/javascript">\r
229     window.___gcfg = {\r
230       lang: 'en-US'\r
231     };\r
232 \r
233     (function() {\r
234       var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;\r
235       po.src = 'https://apis.google.com/js/plusone.js';\r
236       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);\r
237     })();\r
238   </script>\r
239 </div>\r
240 \r
241 <div class="main">\r
242 \r
243 <h1>Module composite Methods</h1>
244 <p class="navigation-index">[<a href="#CompositeImageChannel">CompositeImageChannel</a> &bull; <a href="#TextureImage">TextureImage</a>]</p>
245
246 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite_8c.html" id="CompositeImageChannel">CompositeImageChannel</a></h2>
247 <div class="doc-section">
248
249 <p>CompositeImageChannel() returns the second image composited onto the first at the specified offset, using the specified composite method.</p>
250
251 <p>The format of the CompositeImageChannel method is:</p>
252
253 <pre class="code">
254   MagickBooleanType CompositeImage(Image *image,
255     const CompositeOperator compose,Image *composite_image,
256     const ssize_t x_offset,const ssize_t y_offset)
257   MagickBooleanType CompositeImageChannel(Image *image,
258     const ChannelType channel,const CompositeOperator compose,
259     Image *composite_image,const ssize_t x_offset,const ssize_t y_offset)
260 </pre>
261
262 <p>A description of each parameter follows:</p>
263
264 <h5>image</h5>
265 <p>the destination image, modified by he composition</p>
266
267 <h5>channel</h5>
268 <p>the channel.</p>
269
270 <h5>compose</h5>
271 <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>
272
273 <h5>composite_image</h5>
274 <p>the composite (source) image.</p>
275
276 <h5>x_offset</h5>
277 <p>the column offset of the composited image.</p>
278
279 <h5>y_offset</h5>
280 <p>the row offset of the composited image.</p>
281
282 <p>Extra Controls from Image meta-data in 'composite_image' (artifacts)</p>
283
284 <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>
285
286 <p>Compose methods needing such arguments include "BlendCompositeOp" and "DisplaceCompositeOp".</p>
287
288 <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>
289
290 <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>
291
292 <p>Previous to IM v6.5.3-3  this was called "modify-outside-overlay"</p>
293
294  </div>
295 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite_8c.html" id="TextureImage">TextureImage</a></h2>
296 <div class="doc-section">
297
298 <p>TextureImage() repeatedly tiles the texture image across and down the image canvas.</p>
299
300 <p>The format of the TextureImage method is:</p>
301
302 <pre class="code">
303   MagickBooleanType TextureImage(Image *image,const Image *texture)
304 </pre>
305
306 <p>A description of each parameter follows:</p>
307
308 <h5>image</h5>
309 <p>the image.</p>
310
311 <h5>texture</h5>
312 <p>This image is the texture to layer on the background.</p>
313
314  </div>
315 \r
316 </div>\r
317 \r
318 <div id="linkbar">\r
319     <span id="linkbar-west">&nbsp;</span>\r
320     <span id="linkbar-center">\r
321       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
322       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
323     </span>\r
324     <span id="linkbar-east">&nbsp;</span>\r
325   </div>\r
326   <div class="footer">\r
327     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
328     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
329   </div>\r
330   <div style="clear: both; margin: 0; width: 100%; "></div>\r
331   <script type="text/javascript">\r
332     var _gaq = _gaq || [];\r
333     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
334     _gaq.push(['_trackPageview']);\r
335 \r
336     (function() {\r
337       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
338       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
339       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
340     })();\r
341   </script>\r
342 </body>\r
343 </html>\r