Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 575d5ee5a36355a955ef1a394c9d13d0eedde5bf / . / www / api / image.html
blob: 972a7bb6437721af94bee413eb8f011874a763e4 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]3<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Image Methods</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]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."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
19 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, image, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]32 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]48</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]52<div style="margin: 17px auto; float: left;">
53 <script type="text/javascript">
54 <!--
55 google_ad_client = "pub-3129977114552745";
56 google_ad_slot = "5439289906";
57 google_ad_width = 728;
58 google_ad_height = 90;
59 //-->
60 </script>
61 <script type="text/javascript"
62 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
63 </script>
64</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]66 <img src="../../images/logo.jpg"
67 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]68 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]70 <img src="../../images/sprite.jpg"
71 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]72 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
73</div>
74
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]75<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]76
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]82 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
83</div>
84<div class="sub">
85 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
89</div>
90<div class="sub">
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]91 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
92</div>
93<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]94 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
95</div>
96<div class="sep"></div>
97<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]98 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]101 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]104 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
106<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]107 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108</div>
109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]122 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
128<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
131<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]132 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133 </div>
134<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]135 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]137<div class="menu">
138 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
139</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]141 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]143<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]145 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]149 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]152 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]154<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]156 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]158<a href="http://www.networkredux.com">
159 <img src="../../images/networkredux.png" alt="[sponsor]"
160 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]162<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]163 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]164</div>
165<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]166 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]167</div>
168<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame^]169 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]170</div>
171<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]172 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]173</div>
174<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]175 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]176</div>
177<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]178 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]179</div>
180<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]181 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]182</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]183<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]184 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]185</div>
186<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]187 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]188</div>
189<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame^]190 <a rel="follow" title="Sponsor: Autoteile Online Shop" href="http://www.autoteile-carparts.de">Autoteile Online Shop</a><!-- 2011080100030 autoteile-Carparts-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]191</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]192</div>
193</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]194</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]195
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]196<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]197
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]198</div>
199
200<div class="main">
201
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]202<h1>Module image Methods</h1>
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]203<p class="navigation-index">[<a href="#AcquireImage">AcquireImage</a> &bull; <a href="#AcquireImageInfo">AcquireImageInfo</a> &bull; <a href="#AcquireNextImage">AcquireNextImage</a> &bull; <a href="#AppendImages">AppendImages</a> &bull; <a href="#CatchImageException">CatchImageException</a> &bull; <a href="#ClipImagePath">ClipImagePath</a> &bull; <a href="#CloneImage">CloneImage</a> &bull; <a href="#CloneImageInfo">CloneImageInfo</a> &bull; <a href="#CombineImages">CombineImages</a> &bull; <a href="#DestroyImage">DestroyImage</a> &bull; <a href="#DestroyImageInfo">DestroyImageInfo</a> &bull; <a href="#GetImageAlphaChannel">GetImageAlphaChannel</a> &bull; <a href="#GetImageClipMask">GetImageClipMask</a> &bull; <a href="#GetImageException">GetImageException</a> &bull; <a href="#GetImageInfo">GetImageInfo</a> &bull; <a href="#GetImageInfoFile">GetImageInfoFile</a> &bull; <a href="#GetImageMask">GetImageMask</a> &bull; <a href="#GetImageChannels">GetImageChannels</a> &bull; <a href="#GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a> &bull; <a href="#InterpretImageFilename">InterpretImageFilename</a> &bull; <a href="#IsHighDynamicRangeImage">IsHighDynamicRangeImage</a> &bull; <a href="#IsImageObject">IsImageObject</a> &bull; <a href="#IsTaintImage">IsTaintImage</a> &bull; <a href="#ModifyImage">ModifyImage</a> &bull; <a href="#NewMagickImage">NewMagickImage</a> &bull; <a href="#ReferenceImage">ReferenceImage</a> &bull; <a href="#ResetImagePage">ResetImagePage</a> &bull; <a href="#SeparateImageChannel">SeparateImageChannel</a> &bull; <a href="#SeparateImages">SeparateImages</a> &bull; <a href="#SetImageAlphaChannel">SetImageAlphaChannel</a> &bull; <a href="#SetImageBackgroundColor">SetImageBackgroundColor</a> &bull; <a href="#SetImageChannels">SetImageChannels</a> &bull; <a href="#SetImageColor">SetImageColor</a> &bull; <a href="#SetImageStorageClass">SetImageStorageClass</a> &bull; <a href="#SetImageClipMask">SetImageClipMask</a> &bull; <a href="#SetImageExtent">SetImageExtent</a> &bull; <a href="#SetImageInfoBlob">SetImageInfoBlob</a> &bull; <a href="#SetImageInfoFile">SetImageInfoFile</a> &bull; <a href="#SetImageMask">SetImageMask</a> &bull; <a href="#SetImageOpacity">SetImageOpacity</a> &bull; <a href="#SetImageType">SetImageType</a> &bull; <a href="#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a> &bull; <a href="#SmushImages">SmushImages</a> &bull; <a href="#StripImage">StripImage</a> &bull; <a href="#SyncImageSettings">SyncImageSettings</a>]</p>
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]204
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]205<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireImage">AcquireImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]206<div class="doc-section">
207
208<p>AcquireImage() returns a pointer to an image structure initialized to default values.</p>
209
210<p>The format of the AcquireImage method is:</p>
211
212<pre class="code">
213 Image *AcquireImage(const ImageInfo *image_info)
214</pre>
215
216<p>A description of each parameter follows:</p>
217
218<h5>image_info</h5>
219<p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p>
220
221 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]222<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireImageInfo">AcquireImageInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]223<div class="doc-section">
224
225<p>AcquireImageInfo() allocates the ImageInfo structure.</p>
226
227<p>The format of the AcquireImageInfo method is:</p>
228
229<pre class="code">
230 ImageInfo *AcquireImageInfo(void)
231</pre>
232
233 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]234<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireNextImage">AcquireNextImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]235<div class="doc-section">
236
237<p>AcquireNextImage() initializes the next image in a sequence to default values. The next member of image points to the newly allocated image. If there is a memory shortage, next is assigned NULL.</p>
238
239<p>The format of the AcquireNextImage method is:</p>
240
241<pre class="code">
242 void AcquireNextImage(const ImageInfo *image_info,Image *image)
243</pre>
244
245<p>A description of each parameter follows:</p>
246
247<h5>image_info</h5>
248<p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p>
249
250<h5>image</h5>
251<p>the image.</p>
252
253 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]254<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AppendImages">AppendImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]255<div class="doc-section">
256
257<p>AppendImages() takes all images from the current image pointer to the end of the image list and appends them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.</p>
258
259<p>The current gravity setting now effects how the image is justified in the final image.</p>
260
261<p>The format of the AppendImages method is:</p>
262
263<pre class="code">
264 Image *AppendImages(const Image *images,const MagickBooleanType stack,
265 ExceptionInfo *exception)
266</pre>
267
268<p>A description of each parameter follows:</p>
269
270<h5>images</h5>
271<p>the image sequence.</p>
272
273<h5>stack</h5>
274<p>A value other than 0 stacks the images top-to-bottom.</p>
275
276<h5>exception</h5>
277<p>return any errors or warnings in this structure.</p>
278
279 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]280<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CatchImageException">CatchImageException</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]281<div class="doc-section">
282
283<p>CatchImageException() returns if no exceptions are found in the image sequence, otherwise it determines the most severe exception and reports it as a warning or error depending on the severity.</p>
284
285<p>The format of the CatchImageException method is:</p>
286
287<pre class="code">
288 ExceptionType CatchImageException(Image *image)
289</pre>
290
291<p>A description of each parameter follows:</p>
292
293<h5>image</h5>
294<p>An image sequence.</p>
295
296 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]297<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ClipImagePath">ClipImagePath</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]298<div class="doc-section">
299
300<p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p>
301
302<p>The format of the ClipImagePath method is:</p>
303
304<pre class="code">
305 MagickBooleanType ClipImagePath(Image *image,const char *pathname,
306 const MagickBooleanType inside)
307</pre>
308
309<p>A description of each parameter follows:</p>
310
311<h5>image</h5>
312<p>the image.</p>
313
314<h5>pathname</h5>
315<p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p>
316
317<h5>inside</h5>
318<p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p>
319
320 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]321<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CloneImage">CloneImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]322<div class="doc-section">
323
cristy323f35b2011-03-24 23:05:13 +0000[diff] [blame]324<p>CloneImage() copies an image and returns the copy as a new image object.</p>
325
326<p>If the specified columns and rows is 0, an exact copy of the image is returned, otherwise the pixel data is undefined and must be initialized with the QueueAuthenticPixels() and SyncAuthenticPixels() methods. On failure, a NULL image is returned and exception describes the reason for the failure.</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]327
328<p>The format of the CloneImage method is:</p>
329
330<pre class="code">
331 Image *CloneImage(const Image *image,const size_t columns,
332 const size_t rows,const MagickBooleanType orphan,
333 ExceptionInfo *exception)
334</pre>
335
336<p>A description of each parameter follows:</p>
337
338<h5>image</h5>
339<p>the image.</p>
340
341<h5>columns</h5>
342<p>the number of columns in the cloned image.</p>
343
344<h5>rows</h5>
345<p>the number of rows in the cloned image.</p>
346
347<h5>detach</h5>
348<p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p>
349
350<h5>exception</h5>
351<p>return any errors or warnings in this structure.</p>
352
353 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]354<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CloneImageInfo">CloneImageInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]355<div class="doc-section">
356
357<p>CloneImageInfo() makes a copy of the given image info structure. If NULL is specified, a new image info structure is created initialized to default values.</p>
358
359<p>The format of the CloneImageInfo method is:</p>
360
361<pre class="code">
362 ImageInfo *CloneImageInfo(const ImageInfo *image_info)
363</pre>
364
365<p>A description of each parameter follows:</p>
366
367<h5>image_info</h5>
368<p>the image info.</p>
369
370 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]371<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CombineImages">CombineImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]372<div class="doc-section">
373
374<p>CombineImages() combines one or more images into a single image. The grayscale value of the pixels of each image in the sequence is assigned in order to the specified channels of the combined image. The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.</p>
375
376<p>The format of the CombineImages method is:</p>
377
378<pre class="code">
379 Image *CombineImages(const Image *image,const ChannelType channel,
380 ExceptionInfo *exception)
381</pre>
382
383<p>A description of each parameter follows:</p>
384
385<h5>image</h5>
386<p>the image.</p>
387
388<h5>exception</h5>
389<p>return any errors or warnings in this structure.</p>
390
391 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]392<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="DestroyImage">DestroyImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]393<div class="doc-section">
394
395<p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p>
396
397<p>The format of the DestroyImage method is:</p>
398
399<pre class="code">
400 Image *DestroyImage(Image *image)
401</pre>
402
403<p>A description of each parameter follows:</p>
404
405<h5>image</h5>
406<p>the image.</p>
407
408 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]409<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="DestroyImageInfo">DestroyImageInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]410<div class="doc-section">
411
412<p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p>
413
414<p>The format of the DestroyImageInfo method is:</p>
415
416<pre class="code">
417 ImageInfo *DestroyImageInfo(ImageInfo *image_info)
418</pre>
419
420<p>A description of each parameter follows:</p>
421
422<h5>image_info</h5>
423<p>the image info.</p>
424
425 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]426<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]427<div class="doc-section">
428
429<p>GetImageAlphaChannel() returns MagickFalse if the image alpha channel is not activated. That is, the image is RGB rather than RGBA or CMYK rather than CMYKA.</p>
430
431<p>The format of the GetImageAlphaChannel method is:</p>
432
433<pre class="code">
434 MagickBooleanType GetImageAlphaChannel(const Image *image)
435</pre>
436
437<p>A description of each parameter follows:</p>
438
439<h5>image</h5>
440<p>the image.</p>
441
442 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]443<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageClipMask">GetImageClipMask</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]444<div class="doc-section">
445
446<p>GetImageClipMask() returns the clip path associated with the image.</p>
447
448<p>The format of the GetImageClipMask method is:</p>
449
450<pre class="code">
451 Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
452</pre>
453
454<p>A description of each parameter follows:</p>
455
456<h5>image</h5>
457<p>the image.</p>
458
459 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]460<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageException">GetImageException</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]461<div class="doc-section">
462
463<p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p>
464
465<p>The format of the GetImageException method is:</p>
466
467<pre class="code">
468 void GetImageException(Image *image,ExceptionInfo *exception)
469</pre>
470
471<p>A description of each parameter follows:</p>
472
473<h5>image</h5>
474<p>Specifies a pointer to a list of one or more images.</p>
475
476<h5>exception</h5>
477<p>return the highest severity exception.</p>
478
479 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]480<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageInfo">GetImageInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]481<div class="doc-section">
482
483<p>GetImageInfo() initializes image_info to default values.</p>
484
485<p>The format of the GetImageInfo method is:</p>
486
487<pre class="code">
488 void GetImageInfo(ImageInfo *image_info)
489</pre>
490
491<p>A description of each parameter follows:</p>
492
493<h5>image_info</h5>
494<p>the image info.</p>
495
496 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]497<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageInfoFile">GetImageInfoFile</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]498<div class="doc-section">
499
500<p>GetImageInfoFile() returns the image info file member.</p>
501
502<p>The format of the GetImageInfoFile method is:</p>
503
504<pre class="code">
505 FILE *GetImageInfoFile(const ImageInfo *image_info)
506</pre>
507
508<p>A description of each parameter follows:</p>
509
510<h5>image_info</h5>
511<p>the image info.</p>
512
513 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]514<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageMask">GetImageMask</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]515<div class="doc-section">
516
517<p>GetImageMask() returns the mask associated with the image.</p>
518
519<p>The format of the GetImageMask method is:</p>
520
521<pre class="code">
522 Image *GetImageMask(const Image *image,ExceptionInfo *exception)
523</pre>
524
525<p>A description of each parameter follows:</p>
526
527<h5>image</h5>
528<p>the image.</p>
529
530 </div>
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]531<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageChannels">GetImageChannels</a></h2>
532<div class="doc-section">
533
534<p>GetImageChannels() returns the number of pixel channels associated with the specified image.</p>
535
536<p>The format of the GetChannels method is:</p>
537
538<pre class="code">
539 size_t GetImageChannels(Image *image)
540</pre>
541
542<p>A description of each parameter follows:</p>
543
544<h5>image</h5>
545<p>the image.</p>
546
547 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]548<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]549<div class="doc-section">
550
551<p>GetImageVirtualPixelMethod() gets the "virtual pixels" method for the image. A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p>
552
553<p>The format of the GetImageVirtualPixelMethod() method is:</p>
554
555<pre class="code">
556 VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
557</pre>
558
559<p>A description of each parameter follows:</p>
560
561<h5>image</h5>
562<p>the image.</p>
563
564 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]565<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="InterpretImageFilename">InterpretImageFilename</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]566<div class="doc-section">
567
568<p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p>
569
570<p>The format of the InterpretImageFilename method is:</p>
571
572<pre class="code">
573 size_t InterpretImageFilename(const ImageInfo *image_info,
574 Image *image,const char *format,int value,char *filename)
575</pre>
576
577<p>A description of each parameter follows.</p>
578
579<h5>image_info</h5>
580<p>the image info..</p>
581
582<h5>image</h5>
583<p>the image.</p>
584
585<h5>format</h5>
586<p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p>
587
588<h5>value</h5>
589<p>Numeric value to substitute into format filename.</p>
590
591<h5>filename</h5>
592<p>return the formatted filename in this character buffer.</p>
593
594 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]595<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]596<div class="doc-section">
597
598<p>IsHighDynamicRangeImage() returns MagickTrue if any pixel component is non-integer or exceeds the bounds of the quantum depth (e.g. for Q16 0..65535.</p>
599
600<p>The format of the IsHighDynamicRangeImage method is:</p>
601
602<pre class="code">
603 MagickBooleanType IsHighDynamicRangeImage(const Image *image,
604 ExceptionInfo *exception)
605</pre>
606
607<p>A description of each parameter follows:</p>
608
609<h5>image</h5>
610<p>the image.</p>
611
612<h5>exception</h5>
613<p>return any errors or warnings in this structure.</p>
614
615 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]616<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsImageObject">IsImageObject</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]617<div class="doc-section">
618
619<p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p>
620
621<p>The format of the IsImageObject method is:</p>
622
623<pre class="code">
624 MagickBooleanType IsImageObject(const Image *image)
625</pre>
626
627<p>A description of each parameter follows:</p>
628
629<h5>image</h5>
630<p>the image.</p>
631
632 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]633<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsTaintImage">IsTaintImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]634<div class="doc-section">
635
636<p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p>
637
638<p>The format of the IsTaintImage method is:</p>
639
640<pre class="code">
641 MagickBooleanType IsTaintImage(const Image *image)
642</pre>
643
644<p>A description of each parameter follows:</p>
645
646<h5>image</h5>
647<p>the image.</p>
648
649 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]650<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ModifyImage">ModifyImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]651<div class="doc-section">
652
653<p>ModifyImage() ensures that there is only a single reference to the image to be modified, updating the provided image pointer to point to a clone of the original image if necessary.</p>
654
655<p>The format of the ModifyImage method is:</p>
656
657<pre class="code">
658 MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
659</pre>
660
661<p>A description of each parameter follows:</p>
662
663<h5>image</h5>
664<p>the image.</p>
665
666<h5>exception</h5>
667<p>return any errors or warnings in this structure.</p>
668
669 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]670<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="NewMagickImage">NewMagickImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]671<div class="doc-section">
672
673<p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p>
674
675<p>The format of the NewMagickImage method is:</p>
676
677<pre class="code">
678 Image *NewMagickImage(const ImageInfo *image_info,
679 const size_t width,const size_t height,
680 const MagickPixelPacket *background)
681</pre>
682
683<p>A description of each parameter follows:</p>
684
685<h5>image</h5>
686<p>the image.</p>
687
688<h5>width</h5>
689<p>the image width.</p>
690
691<h5>height</h5>
692<p>the image height.</p>
693
694<h5>background</h5>
695<p>the image color.</p>
696
697 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]698<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ReferenceImage">ReferenceImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]699<div class="doc-section">
700
701<p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p>
702
703<p>The format of the ReferenceImage method is:</p>
704
705<pre class="code">
706 Image *ReferenceImage(Image *image)
707</pre>
708
709<p>A description of each parameter follows:</p>
710
711<h5>image</h5>
712<p>the image.</p>
713
714 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]715<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ResetImagePage">ResetImagePage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]716<div class="doc-section">
717
718<p>ResetImagePage() resets the image page canvas and position.</p>
719
720<p>The format of the ResetImagePage method is:</p>
721
722<pre class="code">
723 MagickBooleanType ResetImagePage(Image *image,const char *page)
724</pre>
725
726<p>A description of each parameter follows:</p>
727
728<h5>image</h5>
729<p>the image.</p>
730
731<h5>page</h5>
732<p>the relative page specification.</p>
733
734 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]735<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SeparateImageChannel">SeparateImageChannel</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]736<div class="doc-section">
737
738<p>SeparateImageChannel() separates a channel from the image and returns it as a grayscale image. A channel is a particular color component of each pixel in the image.</p>
739
740<p>The format of the SeparateImageChannel method is:</p>
741
742<pre class="code">
743 MagickBooleanType SeparateImageChannel(Image *image,
744 const ChannelType channel)
745</pre>
746
747<p>A description of each parameter follows:</p>
748
749<h5>image</h5>
750<p>the image.</p>
751
752<h5>channel</h5>
753<p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p>
754
755 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]756<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SeparateImages">SeparateImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]757<div class="doc-section">
758
759<p>SeparateImages() returns a separate grayscale image for each channel specified.</p>
760
761<p>The format of the SeparateImages method is:</p>
762
763<pre class="code">
764 MagickBooleanType SeparateImages(const Image *image,
765 const ChannelType channel,ExceptionInfo *exception)
766</pre>
767
768<p>A description of each parameter follows:</p>
769
770<h5>image</h5>
771<p>the image.</p>
772
773<h5>channel</h5>
774<p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p>
775
776<h5>exception</h5>
777<p>return any errors or warnings in this structure.</p>
778
779 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]780<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]781<div class="doc-section">
782
783<p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p>
784
785<p>The format of the SetImageAlphaChannel method is:</p>
786
787<pre class="code">
788 MagickBooleanType SetImageAlphaChannel(Image *image,
789 const AlphaChannelType alpha_type)
790</pre>
791
792<p>A description of each parameter follows:</p>
793
794<h5>image</h5>
795<p>the image.</p>
796
797<h5>alpha_type</h5>
798<p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p>
799
800 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]801<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]802<div class="doc-section">
803
804<p>SetImageBackgroundColor() initializes the image pixels to the image background color. The background color is defined by the background_color member of the image structure.</p>
805
806<p>The format of the SetImage method is:</p>
807
808<pre class="code">
809 MagickBooleanType SetImageBackgroundColor(Image *image)
810</pre>
811
812<p>A description of each parameter follows:</p>
813
814<h5>image</h5>
815<p>the image.</p>
816
817 </div>
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]818<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageChannels">SetImageChannels</a></h2>
819<div class="doc-section">
820
821<p>SetImageChannels() sets the number of pixels channels associated with the image.</p>
822
823<p>The format of the SetImageChannels method is:</p>
824
825<pre class="code">
826 MagickBooleanType SetImageChannels(Image *image,const size_t channels)
827</pre>
828
829<p>A description of each parameter follows:</p>
830
831<h5>image</h5>
832<p>the image.</p>
833
834<h5>channels</h5>
835<p>The number of pixel channels.</p>
836
837 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]838<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageColor">SetImageColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]839<div class="doc-section">
840
841<p>SetImageColor() set the entire image canvas to the specified color.</p>
842
843<p>The format of the SetImageColor method is:</p>
844
845<pre class="code">
846 MagickBooleanType SetImageColor(Image *image,
847 const MagickPixelPacket *color)
848</pre>
849
850<p>A description of each parameter follows:</p>
851
852<h5>image</h5>
853<p>the image.</p>
854
855<h5>background</h5>
856<p>the image color.</p>
857
858 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]859<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageStorageClass">SetImageStorageClass</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]860<div class="doc-section">
861
862<p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p>
863
864<p>The format of the SetImageStorageClass method is:</p>
865
866<pre class="code">
867 MagickBooleanType SetImageStorageClass(Image *image,
868 const ClassType storage_class)
869</pre>
870
871<p>A description of each parameter follows:</p>
872
873<h5>image</h5>
874<p>the image.</p>
875
876<h5>storage_class</h5>
877<p>The image class.</p>
878
879 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]880<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageClipMask">SetImageClipMask</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]881<div class="doc-section">
882
883<p>SetImageClipMask() associates a clip path with the image. The clip path must be the same dimensions as the image. Set any pixel component of the clip path to TransparentOpacity to prevent that corresponding image pixel component from being updated when SyncAuthenticPixels() is applied.</p>
884
885<p>The format of the SetImageClipMask method is:</p>
886
887<pre class="code">
888 MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
889</pre>
890
891<p>A description of each parameter follows:</p>
892
893<h5>image</h5>
894<p>the image.</p>
895
896<h5>clip_mask</h5>
897<p>the image clip path.</p>
898
899 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]900<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageExtent">SetImageExtent</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]901<div class="doc-section">
902
903<p>SetImageExtent() sets the image size (i.e. columns & rows).</p>
904
905<p>The format of the SetImageExtent method is:</p>
906
907<pre class="code">
908 MagickBooleanType SetImageExtent(Image *image,
909 const size_t columns,const size_t rows)
910</pre>
911
912<p>A description of each parameter follows:</p>
913
914<h5>image</h5>
915<p>the image.</p>
916
917<h5>columns</h5>
918<p>The image width in pixels.</p>
919
920<h5>rows</h5>
921<p>The image height in pixels.</p>
922
923 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]924<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageInfoBlob">SetImageInfoBlob</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]925<div class="doc-section">
926
927<p>SetImageInfoBlob() sets the image info blob member.</p>
928
929<p>The format of the SetImageInfoBlob method is:</p>
930
931<pre class="code">
932 void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
933 const size_t length)
934</pre>
935
936<p>A description of each parameter follows:</p>
937
938<h5>image_info</h5>
939<p>the image info.</p>
940
941<h5>blob</h5>
942<p>the blob.</p>
943
944<h5>length</h5>
945<p>the blob length.</p>
946
947 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]948<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageInfoFile">SetImageInfoFile</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]949<div class="doc-section">
950
951<p>SetImageInfoFile() sets the image info file member.</p>
952
953<p>The format of the SetImageInfoFile method is:</p>
954
955<pre class="code">
956 void SetImageInfoFile(ImageInfo *image_info,FILE *file)
957</pre>
958
959<p>A description of each parameter follows:</p>
960
961<h5>image_info</h5>
962<p>the image info.</p>
963
964<h5>file</h5>
965<p>the file.</p>
966
967 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]968<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageMask">SetImageMask</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]969<div class="doc-section">
970
971<p>SetImageMask() associates a mask with the image. The mask must be the same dimensions as the image.</p>
972
973<p>The format of the SetImageMask method is:</p>
974
975<pre class="code">
976 MagickBooleanType SetImageMask(Image *image,const Image *mask)
977</pre>
978
979<p>A description of each parameter follows:</p>
980
981<h5>image</h5>
982<p>the image.</p>
983
984<h5>mask</h5>
985<p>the image mask.</p>
986
987 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]988<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageOpacity">SetImageOpacity</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]989<div class="doc-section">
990
991<p>SetImageOpacity() sets the opacity levels of the image.</p>
992
993<p>The format of the SetImageOpacity method is:</p>
994
995<pre class="code">
996 MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
997</pre>
998
999<p>A description of each parameter follows:</p>
1000
1001<h5>image</h5>
1002<p>the image.</p>
1003
1004<h5>opacity</h5>
1005<p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p>
1006
1007 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1008<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageType">SetImageType</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1009<div class="doc-section">
1010
1011<p>SetImageType() sets the type of image. Choose from these types:</p>
1012
1013<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p>
1014
1015<p>The format of the SetImageType method is:</p>
1016
1017<pre class="code">
1018 MagickBooleanType SetImageType(Image *image,const ImageType type)
1019</pre>
1020
1021<p>A description of each parameter follows:</p>
1022
1023<h5>image</h5>
1024<p>the image.</p>
1025
1026<h5>type</h5>
1027<p>Image type.</p>
1028
1029 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1030<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1031<div class="doc-section">
1032
1033<p>SetImageVirtualPixelMethod() sets the "virtual pixels" method for the image and returns the previous setting. A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p>
1034
1035<p>The format of the SetImageVirtualPixelMethod() method is:</p>
1036
1037<pre class="code">
1038 VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
1039 const VirtualPixelMethod virtual_pixel_method)
1040</pre>
1041
1042<p>A description of each parameter follows:</p>
1043
1044<h5>image</h5>
1045<p>the image.</p>
1046
1047<h5>virtual_pixel_method</h5>
1048<p>choose the type of virtual pixel.</p>
1049
1050 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1051<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SmushImages">SmushImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1052<div class="doc-section">
1053
1054<p>SmushImages() takes all images from the current image pointer to the end of the image list and smushes them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.</p>
1055
1056<p>The current gravity setting now effects how the image is justified in the final image.</p>
1057
1058<p>The format of the SmushImages method is:</p>
1059
1060<pre class="code">
1061 Image *SmushImages(const Image *images,const MagickBooleanType stack,
1062 ExceptionInfo *exception)
1063</pre>
1064
1065<p>A description of each parameter follows:</p>
1066
1067<h5>images</h5>
1068<p>the image sequence.</p>
1069
1070<h5>stack</h5>
1071<p>A value other than 0 stacks the images top-to-bottom.</p>
1072
1073<h5>offset</h5>
1074<p>minimum distance in pixels between images.</p>
1075
1076<h5>exception</h5>
1077<p>return any errors or warnings in this structure.</p>
1078
1079 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1080<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="StripImage">StripImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1081<div class="doc-section">
1082
1083<p>StripImage() strips an image of all profiles and comments.</p>
1084
1085<p>The format of the StripImage method is:</p>
1086
1087<pre class="code">
1088 MagickBooleanType StripImage(Image *image)
1089</pre>
1090
1091<p>A description of each parameter follows:</p>
1092
1093<h5>image</h5>
1094<p>the image.</p>
1095
1096 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1097<h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SyncImageSettings">SyncImageSettings</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1098<div class="doc-section">
1099
1100<p>SyncImageSettings() sync the image info options to the image.</p>
1101
1102<p>The format of the SyncImageSettings method is:</p>
1103
1104<pre class="code">
1105 MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
1106 Image *image)
1107 MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
1108 Image *image)
1109</pre>
1110
1111<p>A description of each parameter follows:</p>
1112
1113<h5>image_info</h5>
1114<p>the image info.</p>
1115
1116<h5>image</h5>
1117<p>the image.</p>
1118
1119 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1120
1121</div>
1122
1123<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]1124 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1125 <span id="linkbar-center">
1126 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]1127 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1128 </span>
1129 <span id="linkbar-east">&nbsp;</span>
1130 </div>
1131 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]1132 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1133 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
1134 </div>
1135 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]1136 <script type="text/javascript">
1137 var _gaq = _gaq || [];
1138 _gaq.push(['_setAccount', 'UA-17690367-1']);
1139 _gaq.push(['_trackPageview']);
1140
1141 (function() {
1142 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
1143 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
1144 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
1145 })();
1146 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1147</body>
1148</html>