Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 16ff93cc0754b9fffc8794443e5b53c631824d02 / . / www / api / composite.html
blob: 3c4dff54fbe09505c96b14bd7d32207eb3cc3c01 [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]5 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
10 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../../www/architecture.html">Architecture</a>
80</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
83 <a href="../../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../../www/resources.html">Resources</a>
105</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
116 <a href="../../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../../www/links.html">Links</a>
120</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame^]127 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
cristy05651072009-11-18 17:07:16 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]130 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame^]133 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201006010120 Buchhorn -->
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame]134</div>
135<div class="sponsor">
136 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]139 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
140</div>
141<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame^]142 <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame^]145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]152
153
154</div>
155
156<div class="main">
157
cristy43d0f4d2009-09-17 19:35:37 +0000[diff] [blame]158<p class="navigation-index">[<a href="#CompositeImageChannel">CompositeImageChannel</a> &bull; <a href="#TextureImage">TextureImage</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]159
160<h2><a href="http://www.imagemagick.org/api/MagickCore/composite
161_8c.html" target="source" name="CompositeImageChannel">CompositeImageChannel</a></h2>
162<div class="doc-section">
163
164<p>CompositeImageChannel() returns the second image composited onto the first at the specified offset, using the specified composite method.</p></ol>
165
166<p>The format of the CompositeImageChannel method is:</p>
167
168<pre class="code">
169 MagickBooleanType CompositeImage(Image *image,
170 const CompositeOperator compose,Image *composite_image,
171 const long x_offset,const long y_offset)
172 MagickBooleanType CompositeImageChannel(Image *image,
173 const ChannelType channel,const CompositeOperator compose,
174 Image *composite_image,const long x_offset,const long y_offset)
175</pre>
176
177<p>A description of each parameter follows:</p></ol>
178
179<h5>image</h5>
180<ol><p>the destination image, modified by he composition</p></ol>
181
182<h5>channel</h5>
183<ol><p>the channel.</p></ol>
184
185<h5>compose</h5>
186<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>
187
188<h5>composite_image</h5>
189<ol><p>the composite (source) image.</p></ol>
190
191<h5>x_offset</h5>
192<ol><p>the column offset of the composited image.</p></ol>
193
194<h5>y_offset</h5>
195<ol><p>the row offset of the composited image.</p></ol>
196
197<p>Extra Controls from Image meta-data in 'composite_image' (artifacts)</p></ol>
198
199<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>
200
201<p>Compose methods needing such arguments include "BlendCompositeOp" and "DisplaceCompositeOp".</p></ol>
202
203<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>
204
205<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>
206
207<p>Previous to IM v6.5.3-3 this was called "modify-outside-overlay"</p></ol>
208
209 </div>
cristy43d0f4d2009-09-17 19:35:37 +0000[diff] [blame]210<h2><a href="http://www.imagemagick.org/api/MagickCore/composite
211_8c.html" target="source" name="TextureImage">TextureImage</a></h2>
212<div class="doc-section">
213
214<p>TextureImage() repeatedly tiles the texture image across and down the image canvas.</p></ol>
215
216<p>The format of the TextureImage method is:</p>
217
218<pre class="code">
219 MagickBooleanType TextureImage(Image *image,const Image *texture)
220</pre>
221
222<p>A description of each parameter follows:</p></ol>
223
224<h5>image</h5>
225<ol><p>the image.</p></ol>
226
227<h5>texture</h5>
228<ol><p>This image is the texture to layer on the background.</p></ol>
229
230 </div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]231
232</div>
233
234<div id="linkbar">
235 <!-- <span id="linkbar-west">&nbsp;</span> -->
236 <span id="linkbar-center">
237 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
238 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristyfcb2a812009-12-27 20:24:28 +0000[diff] [blame]239 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]240 </span>
241 <span id="linkbar-east">&nbsp;</span>
242 </div>
243 <div class="footer">
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]244 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]245 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
246 </div>
247 <div style="clear: both; margin: 0; width: 100%; "></div>
248</body>
249</html>