]> 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.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="westbar">\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="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53 </div>
54 <div class="sub">
55     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56 </div>
57 <div class="sub">
58     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59 </div>
60 <div class="sub">
61     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62 </div>
63 <div class="sep"></div>\r
64 <div class="menu">
65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
66 </div>
67 <div class="sub">
68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
69 </div>
70 <div class="sub">
71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
72 </div>
73 <div class="sub">
74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
75 </div>
76 <div class="menu">
77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
78 </div>
79 <div class="sub">
80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
81 </div>
82 <div class="sub">
83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
84 </div>
85 <div class="sub">
86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
87 </div>
88 <div class="sub">
89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
90 </div>
91 <div class="sep"></div>\r
92 <div  class="menu">
93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
94 </div>
95 <div class="sub">
96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
97 </div>
98 <div class="sub">
99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
100  </div>
101 <div class="menu">
102   <a title="Resources" href="../../www/resources.html">Resources</a>
103 </div>
104 <div class="menu">
105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106 </div>
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: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
128 </div>
129 <div  class="sponsor">
130   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
131 </div>
132 <div  class="sponsor">
133   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
134 </div>
135 <div  class="sponsor">
136   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
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: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
146 </div>
147 </div>
148 </div>
149 </div>\r
150 \r
151 <div class="eastbar">\r
152   <script type="text/javascript">\r
153   <!--\r
154     google_ad_client = "pub-3129977114552745";\r
155     google_ad_slot = "0574824969";\r
156     google_ad_width = 160;\r
157     google_ad_height = 600;\r
158   //-->\r
159   </script>\r
160   <script type="text/javascript"\r
161     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
162   </script>\r
163 </div>\r
164 \r
165 <div class="main">\r
166 \r
167 <p class="navigation-index">[<a href="#CompositeImageChannel">CompositeImageChannel</a> &bull; <a href="#TextureImage">TextureImage</a>]</p>
168
169 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite
170 _8c.html" target="source" name="CompositeImageChannel">CompositeImageChannel</a></h2>
171 <div class="doc-section">
172
173 <p>CompositeImageChannel() returns the second image composited onto the first at the specified offset, using the specified composite method.</p></ol>
174
175 <p>The format of the CompositeImageChannel method is:</p>
176
177 <pre class="code">
178   MagickBooleanType CompositeImage(Image *image,
179     const CompositeOperator compose,Image *composite_image,
180     const ssize_t x_offset,const ssize_t y_offset)
181   MagickBooleanType CompositeImageChannel(Image *image,
182     const ChannelType channel,const CompositeOperator compose,
183     Image *composite_image,const ssize_t x_offset,const ssize_t y_offset)
184 </pre>
185
186 <p>A description of each parameter follows:</p></ol>
187
188 <h5>image</h5>
189 <ol><p>the destination image, modified by he composition</p></ol>
190
191 <h5>channel</h5>
192 <ol><p>the channel.</p></ol>
193
194 <h5>compose</h5>
195 <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>
196
197 <h5>composite_image</h5>
198 <ol><p>the composite (source) image.</p></ol>
199
200 <h5>x_offset</h5>
201 <ol><p>the column offset of the composited image.</p></ol>
202
203 <h5>y_offset</h5>
204 <ol><p>the row offset of the composited image.</p></ol>
205
206 <p>Extra Controls from Image meta-data in 'composite_image' (artifacts)</p></ol>
207
208 <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>
209
210 <p>Compose methods needing such arguments include "BlendCompositeOp" and "DisplaceCompositeOp".</p></ol>
211
212 <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>
213
214 <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>
215
216 <p>Previous to IM v6.5.3-3  this was called "modify-outside-overlay"</p></ol>
217
218  </div>
219 <h2><a href="http://www.imagemagick.org/api/MagickCore/composite
220 _8c.html" target="source" name="TextureImage">TextureImage</a></h2>
221 <div class="doc-section">
222
223 <p>TextureImage() repeatedly tiles the texture image across and down the image canvas.</p></ol>
224
225 <p>The format of the TextureImage method is:</p>
226
227 <pre class="code">
228   MagickBooleanType TextureImage(Image *image,const Image *texture)
229 </pre>
230
231 <p>A description of each parameter follows:</p></ol>
232
233 <h5>image</h5>
234 <ol><p>the image.</p></ol>
235
236 <h5>texture</h5>
237 <ol><p>This image is the texture to layer on the background.</p></ol>
238
239  </div>
240 \r
241 </div>\r
242 \r
243 <div id="linkbar">\r
244     <span id="linkbar-west">&nbsp;</span>\r
245     <span id="linkbar-center">\r
246       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
247       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
248     </span>\r
249     <span id="linkbar-east">&nbsp;</span>\r
250   </div>\r
251   <div class="footer">\r
252     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
253     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
254   </div>\r
255   <div style="clear: both; margin: 0; width: 100%; "></div>\r
256   <script type="text/javascript">\r
257     var _gaq = _gaq || [];\r
258     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
259     _gaq.push(['_trackPageview']);\r
260 \r
261     (function() {\r
262       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
263       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
264       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
265     })();\r
266   </script>\r
267 </body>\r
268 </html>\r