Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / f7964270f2b6d810576a32f8240fca73a352c51a / . / www / api / constitute.html
blob: d29112dfd9f3d3c0be58482c43dd6e471003672c [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">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <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]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <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]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]56 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]57<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]62<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]63
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]69 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]82 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]85 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]86</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</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="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</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="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141
142<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]147 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristyf7964272011-01-30 03:49:12 +0000[diff] [blame^]159 <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]160</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]164
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]181<h1>Module constitute
182 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]183<p class="navigation-index">[<a href="#ConstituteImage">ConstituteImage</a> &bull; <a href="#PingImage">PingImage</a> &bull; <a href="#PingImages">PingImages</a> &bull; <a href="#ReadImage">ReadImage</a> &bull; <a href="#ReadImages">ReadImages</a> &bull; <a href="#WriteImage">WriteImage</a> &bull; <a href="#WriteImages">WriteImages</a>]</p>
184
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]185<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
186_8c.html" id="ConstituteImage">ConstituteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187<div class="doc-section">
188
189<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>
190
191<pre class="text">
192 image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
193</pre>
194
195<p>The format of the ConstituteImage method is:</p>
196
197<pre class="code">
cristyeaedf062010-05-29 22:36:02 +0000[diff] [blame]198 Image *ConstituteImage(const size_t columns,const size_t rows,
199 const char *map,const StorageType storage,const void *pixels,
200 ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]201</pre>
202
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]203<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]204
205<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]206<p>width in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]207
208<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]209<p>height in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]210
211<h5>map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]212<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]213
214<h5>storage</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]215<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]216
217<h5>pixels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]218<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]219
220<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]221<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]222
223 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]224<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
225_8c.html" id="PingImage">PingImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]226<div class="doc-section">
227
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]228<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]229
230<p>The format of the PingImage method is:</p>
231
232<pre class="code">
233 Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
234</pre>
235
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]236<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237
238<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]239<p>Ping the image defined by the file or filename members of this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]240
241<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]242<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]243
244 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]245<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
246_8c.html" id="PingImages">PingImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]247<div class="doc-section">
248
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]249<p>PingImages() pings one or more images and returns them as an image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]250
251<p>The format of the PingImage method is:</p>
252
253<pre class="code">
254 Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
255</pre>
256
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]257<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]258
259<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]260<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]261
262<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]263<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]264
265 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]266<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
267_8c.html" id="ReadImage">ReadImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]268<div class="doc-section">
269
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]270<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]271
272<p>The format of the ReadImage method is:</p>
273
274<pre class="code">
275 Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
276</pre>
277
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]278<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]279
280<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]281<p>Read the image defined by the file or filename members of this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]282
283<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]284<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]285
286 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]287<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
288_8c.html" id="ReadImages">ReadImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]289<div class="doc-section">
290
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]291<p>ReadImages() reads one or more images and returns them as an image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]292
293<p>The format of the ReadImage method is:</p>
294
295<pre class="code">
296 Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
297</pre>
298
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]299<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]300
301<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]302<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]303
304<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]305<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]306
307 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]308<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
309_8c.html" id="WriteImage">WriteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]310<div class="doc-section">
311
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]312<p>WriteImage() writes an image or an image sequence to a file or filehandle. If writing to a file on disk, the name is defined by the filename member of the image structure. Write() returns MagickFalse is these 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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]313
314<p>The format of the WriteImage method is:</p>
315
316<pre class="code">
317 MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
318</pre>
319
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]320<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]321
322<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]323<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]324
325<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]326<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]327
328 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]329<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/constitute
330_8c.html" id="WriteImages">WriteImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]331<div class="doc-section">
332
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]333<p>WriteImages() writes an image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]334
335<p>The format of the WriteImages method is:</p>
336
337<pre class="code">
338 MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
339 const char *filename,ExceptionInfo *exception)
340</pre>
341
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]342<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]343
344<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]345<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]346
347<h5>images</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]348<p>the image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]349
350<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]351<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]352
353<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]354<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]355
356 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]357
358</div>
359
360<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]361 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]362 <span id="linkbar-center">
363 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]364 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]365 </span>
366 <span id="linkbar-east">&nbsp;</span>
367 </div>
368 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]369 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]370 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
371 </div>
372 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]373 <script type="text/javascript">
374 var _gaq = _gaq || [];
375 _gaq.push(['_setAccount', 'UA-17690367-1']);
376 _gaq.push(['_trackPageview']);
377
378 (function() {
379 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
380 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
381 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
382 })();
383 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]384</body>
385</html>