Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / d8833bfff34db3ff19b83bdbd945099719f15431 / . / www / api / constitute.html
blob: 916ebcfdec936a6b1d2378126762f1983534ab97 [file] [log] [blame]
cristy06f63f22012-10-31 00: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">
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">
8<head>
9 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
10 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
cristy751980d2012-06-03 23:18:35 +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"/>
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"/>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]19 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, constitute, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
cristy751980d2012-06-03 23:18:35 +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"/>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]26 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]27 <meta name="distribution" content="Global"/>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]30 <link rel="canonical" href="http://www.imagemagick.org" />
31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]33 <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]34 <style type="text/css" media="all">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]35 @import url("../../style/magick.html");
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]36 </style>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]37 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
38 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
39 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>
40 <script type="text/javascript">
41 $(document).ready(function() {
42 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
43 'transitionIn' : 'elastic',
44 'transitionOut' : 'elastic',
45 'overlayShow' : false,
46 'opacity' : true
47 });
48 });
49 </script>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]50</head>
51
52<body id="www-imagemagick-org">
53<div class="titlebar">
54<div style="margin: 17px auto; float: left;">
55 <script type="text/javascript">
56 <!--
57 google_ad_client = "pub-3129977114552745";
58 google_ad_slot = "5439289906";
59 google_ad_width = 728;
60 google_ad_height = 90;
61 //-->
62 </script>
63 <script type="text/javascript"
64 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
65 </script>
66</div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]67<a href="../../discourse-server">
68 <img src="../../images/logo.jpg"
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]69 alt="ImageMagick Logo"
70 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]71<a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]72 <img src="../../images/sprite.jpg"
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]73 alt="ImageMagick Sprite"
74 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
75</div>
76
77<div class="westbar">
78
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]80 <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]83 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]84</div>
85<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]86 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]87</div>
88<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]89 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]90</div>
91<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]92 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]93</div>
94<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]95 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]96</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]97<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]98<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]99 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]102 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]105 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]111 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]114 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]117 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]120 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]123 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]127 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
129<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]130 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]133 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134 </div>
135<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]136 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]138<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]139 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]140</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]142 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]146 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]149<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]150 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151</div>
152<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]153 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]155<div class="sep"></div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]156<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]157 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]159<a href="http://www.networkredux.com">
160 <img src="../../images/networkredux.png" width="140" height="31" alt="[sponsor]"
161 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]162<div class="sponsbox">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]163<div class="sponsor">
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]164 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
165</div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]166<div class="sponsor">
167 <a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... -->
168</div>
169<div class="sponsor">
170 <a rel="follow" title="Sponsor: Best Local Services" href="http://www.openchime.com">Best Local Services</a><!-- 2012010100150 joey@openc... -->
171</div>
172<div class="sponsor">
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]173 <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
174</div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]175<div class="sponsor">
176 <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201201010090 barsh@inter... -->
177</div>
178<div class="sponsor">
179 <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj -->
180</div>
181<div class="sponsor">
182 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
183</div>
184<div class="sponsor">
185 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
186</div>
187<div class="sponsor">
188 <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
189</div>
190<div class="sponsor">
191 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]194 <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]195</div>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]196<div class="sponsor">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]197 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]198</div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]199<div class="sponsor">
200 <a rel="follow" title="Sponsor: Photo Sharing Websites" href="http://www.zoofoo.com">Photo Sharing Websites</a><!-- 2012050100150 dancu@dans...-->
201</div>
202<div class="sponsor">
203 <a rel="follow" title="Sponsor: Got Stripes?" href="http://www.stripeslawncare.org">Got Stripes?</a><!-- 2012010100150 brooks@stripes...-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]204</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205</div>
206</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]207</div>
208
209<div class="eastbar">
210 <div class="g-plusone" id="gplusone"></div>
211 <script type="text/javascript">
212 window.___gcfg = {
213 lang: 'en-US'
214 };
215
216 (function() {
cristy18b955e2013-02-24 21:06:33 +0000[diff] [blame]217 var po = document.createElement('offline-script');
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]218 po.type = 'text/javascript'; po.async = true;
219 po.src = 'https://apis.google.com/js/plusone.js';
cristy18b955e2013-02-24 21:06:33 +0000[diff] [blame]220 var script = document.getElementsByTagName('offline-script')[0];
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]221 script.parentNode.insertBefore(po, script);
222 })();
223 var gplusone = document.getElementById("gplusone");
224 gplusone.setAttribute("data-size","medium");
225 gplusone.setAttribute("data-count","false");
226 </script>
227</div>
228
229<div class="main">
230
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]231<h1>Module constitute Methods</h1>
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]232<p class="navigation-index">[<a href="constitute.html#ConstituteImage">ConstituteImage</a> &bull; <a href="constitute.html#PingImage">PingImage</a> &bull; <a href="constitute.html#PingImages">PingImages</a> &bull; <a href="constitute.html#ReadImage">ReadImage</a> &bull; <a href="constitute.html#ReadImages">ReadImages</a> &bull; <a href="constitute.html#WriteImage">WriteImage</a> &bull; <a href="constitute.html#WriteImages">WriteImages</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]233
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]234<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ConstituteImage">ConstituteImage</a></h2>
235<div class="doc-section">
236
237<p>ConstituteImage() returns an image from the pixel data you supply. The pixel data must be in scanline order top-to-bottom. The data can be char, short int, int, float, or double. Float and double require the pixels to be normalized [0..1], otherwise [0..QuantumRange]. For example, to create a 640x480 image from unsigned red-green-blue character data, use:</p>
238
239<pre class="text">
240 image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
241</pre>
242
243<p>The format of the ConstituteImage method is:</p>
244
245<pre class="code">
246 Image *ConstituteImage(const size_t columns,const size_t rows,
247 const char *map,const StorageType storage,const void *pixels,
248 ExceptionInfo *exception)
249</pre>
250
251<p>A description of each parameter follows:</p>
252
253<h5>columns</h5>
254<p>width in pixels of the image.</p>
255
256<h5>rows</h5>
257<p>height in pixels of the image.</p>
258
259<h5>map</h5>
260<p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p>
261
262<h5>storage</h5>
263<p>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.</p>
264
265<h5>pixels</h5>
266<p>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p>
267
268<h5>exception</h5>
269<p>return any errors or warnings in this structure.</p>
270
271 </div>
272<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="PingImage">PingImage</a></h2>
273<div class="doc-section">
274
275<p>PingImage() returns all the properties of an image or image sequence except for the pixels. It is much faster and consumes far less memory than ReadImage(). On failure, a NULL image is returned and exception describes the reason for the failure.</p>
276
277<p>The format of the PingImage method is:</p>
278
279<pre class="code">
280 Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
281</pre>
282
283<p>A description of each parameter follows:</p>
284
285<h5>image_info</h5>
286<p>Ping the image defined by the file or filename members of this structure.</p>
287
288<h5>exception</h5>
289<p>return any errors or warnings in this structure.</p>
290
291 </div>
292<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="PingImages">PingImages</a></h2>
293<div class="doc-section">
294
295<p>PingImages() pings one or more images and returns them as an image list.</p>
296
297<p>The format of the PingImage method is:</p>
298
299<pre class="code">
300 Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
301</pre>
302
303<p>A description of each parameter follows:</p>
304
305<h5>image_info</h5>
306<p>the image info.</p>
307
308<h5>exception</h5>
309<p>return any errors or warnings in this structure.</p>
310
311 </div>
312<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ReadImage">ReadImage</a></h2>
313<div class="doc-section">
314
315<p>ReadImage() reads an image or image sequence from a file or file handle. The method returns a NULL if there is a memory shortage or if the image cannot be read. On failure, a NULL image is returned and exception describes the reason for the failure.</p>
316
317<p>The format of the ReadImage method is:</p>
318
319<pre class="code">
320 Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
321</pre>
322
323<p>A description of each parameter follows:</p>
324
325<h5>image_info</h5>
326<p>Read the image defined by the file or filename members of this structure.</p>
327
328<h5>exception</h5>
329<p>return any errors or warnings in this structure.</p>
330
331 </div>
332<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ReadImages">ReadImages</a></h2>
333<div class="doc-section">
334
335<p>ReadImages() reads one or more images and returns them as an image list.</p>
336
337<p>The format of the ReadImage method is:</p>
338
339<pre class="code">
340 Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
341</pre>
342
343<p>A description of each parameter follows:</p>
344
345<h5>image_info</h5>
346<p>the image info.</p>
347
348<h5>exception</h5>
349<p>return any errors or warnings in this structure.</p>
350
351 </div>
352<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="WriteImage">WriteImage</a></h2>
353<div class="doc-section">
354
355<p>WriteImage() writes an image or an image sequence to a file or file handle. If writing to a file is on disk, the name is defined by the filename member of the image structure. WriteImage() returns MagickFalse is there is a memory shortage or if the image cannot be written. Check the exception member of image to determine the cause for any failure.</p>
356
357<p>The format of the WriteImage method is:</p>
358
359<pre class="code">
360 MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
361</pre>
362
363<p>A description of each parameter follows:</p>
364
365<h5>image_info</h5>
366<p>the image info.</p>
367
368<h5>image</h5>
369<p>the image.</p>
370
371 </div>
372<h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="WriteImages">WriteImages</a></h2>
373<div class="doc-section">
374
375<p>WriteImages() writes an image sequence into one or more files. While WriteImage() can write an image sequence, it is limited to writing the sequence into a single file using a format which supports multiple frames. WriteImages(), however, does not have this limitation, instead it generates multiple output files if necessary (or when requested). When ImageInfo's adjoin flag is set to MagickFalse, the file name is expected to include a printf-style formatting string for the frame number (e.g. "image02d.png").</p>
376
377<p>The format of the WriteImages method is:</p>
378
379<pre class="code">
380 MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
381 const char *filename,ExceptionInfo *exception)
382</pre>
383
384<p>A description of each parameter follows:</p>
385
386<h5>image_info</h5>
387<p>the image info.</p>
388
389<h5>images</h5>
390<p>the image list.</p>
391
392<h5>filename</h5>
393<p>the image filename.</p>
394
395<h5>exception</h5>
396<p>return any errors or warnings in this structure.</p>
397
398 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]399
400</div>
401
402<div id="linkbar">
403 <span id="linkbar-west">&nbsp;</span>
404 <span id="linkbar-center">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]405 <a href="../../discourse-server">Discourse Server</a> &bull;
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]406 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
407 </span>
408 <span id="linkbar-east">&nbsp;</span>
409 </div>
410 <div class="footer">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]411 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]412 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]413 </div>
414 <div style="clear: both; margin: 0; width: 100%; "></div>
415 <script type="text/javascript">
416 var _gaq = _gaq || [];
417 _gaq.push(['_setAccount', 'UA-17690367-1']);
418 _gaq.push(['_trackPageview']);
419
420 (function() {
cristy18b955e2013-02-24 21:06:33 +0000[diff] [blame]421 var ga = document.createElement('offline-script'); ga.type = 'text/javascript'; ga.async = true;
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]422 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
cristy18b955e2013-02-24 21:06:33 +0000[diff] [blame]423 var s = document.getElementsByTagName('offline-script')[0]; s.parentNode.insertBefore(ga, s);
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]424 })();
425 </script>
426</body>
427</html>